Package index • masque

Guided masking

The one-call front door for a table, a folder, or a workbook.

masque(): Mask a dataset end to end with one guided call

Role discovery

Inspect a data frame and decide what each column is and how to mask it.

propose_roles(): Propose role and action classifications for the columns of a data frame
set_role(): Set the role and action of one or more columns in a roles table
role_options(): List every role and action combination masque accepts
roles_validate(): Validate a roles table
clean_table(): Tidy a dirty table's column names and category labels before masking

Design detection

Identify environment scope and experimental design, then visualise both for sanity.

detect_design(): Detect environment scope and experimental-design structure
plot_design_summary(): Sanity-check visualisation for detected scope and design

Masking

Produce a structurally faithful synthetic clone of one or many tables.

mask(): Mask a tabular dataset into a structurally faithful development surrogate
mask_set(): Mask a multi-table set with cross-table-consistent aliasing
read_set(): Read a set of tables from a folder, an Excel workbook, or a list
write_set(): Write a masked set to disk, mirroring the input format
synthetic(): Extract the synthetic data from a masque object
recipe(): Extract the recipe from a masque object

Recipe round-trip

Persist a recipe and re-target a pipeline between original and synthetic.

save_recipe(): Save a masque recipe to disk
read_recipe(): Read a masque recipe from disk
apply_recipe(): Translate a data frame into the synthetic namespace
unmask(): Translate data from the synthetic namespace back to the original
reveal_maps(): Reveal the level maps held inside a recipe

Leakage audit

Check a synthetic for residual structural leakage.

audit_mask(): Audit a masque object for leakage and shareability risks

Geospatial post-processing

Coarsen or re-anchor synthetic coordinates while keeping them on land and plausible.

jitter_coordinates(): Coarsen geographic coordinates by an on-land privacy jitter
synthesise_geospatial(): Re-anchor synthetic geospatial coordinates at plausible-but-fake locations

Package

masque-package: masque: Structurally Faithful Development Surrogates for Tabular Data