Developer reference

This section is intended for those that want to contribute to the metasyn package, or simply want a deeper understanding of how it works. It contains all the classes, functions and modules in the metasyn package. Most elements are not directly used by users, but are important for developers of the metasyn package to understand the architecture.

Modules

config	Module defining configuration classes for creating MetaFrames.
demo	Package to create and retrieve demo datasets used in tutorials.
distribution	Package providing different distributions used in metasyn.
file	File interfaces to read dataset and write synthetic datasets.
metaframe	Module defining MetaFrames, used for creating MetaFrames from DataFrames.
privacy	Module with privacy classes to be used for creating GMF files.
registry	Module implementing the distribution registry.
schema	Package containing the JSON-schema that can be used for validating metadata.
testutils	Module for testing the functionality of distributions and registries.
util	Utility module for metasyn.
var	Module defining the MetaVar class, which represents a metadata variable.
varspec	Module for distribution and variable specifications.

Top-level classes

MetaFrame(meta_vars[, n_rows, file_format, name])	Container for statistical metadata describing a dataset.
MetaVar(name, var_type, distribution[, ...])	Metadata variable describing a column in a MetaFrame.
VarSpec(name[, distribution, unique, ...])	Data class for storing the specifications for variables.

Top-level functions

demo_dataframe([name])	Legacy alias for demo_data.
demo_file([name])	Get the path for a demo data file.
metadist([name, var_type, unique, version])	Decorate class to create a distribution with the right properties.
read_csv(fp[, separator, eol_char, ...])	Create the file interface from a file.
read_dta(fp[, max_rows, chunk_size])	Read a .dta stata file into metadata and a DataFrame.
read_excel(fp)	Read an excel file and create a file interface from that.
read_sav(fp[, max_rows, chunk_size])	Create the file interface from a .sav or .zsav file.
read_tsv(*args, **kwargs)	Alias for read_csv().
write_csv(df, fp[, file_format, overwrite])	Write to a CSV file with the same file format.
write_dta(df, fp[, file_format, overwrite])	Write to a DTA file with the same file format.
write_excel(df, fp[, file_format, overwrite])	Write to a Excel file with the same file format.
write_sav(df, fp[, file_format, overwrite])	Write to a SAV file with the same file format.
write_tsv(*args, **kwargs)	Alias for write_csv().