Extensions ========== Metasyn is developed with a strong focus on extensibility, allowing developers to easily build upon its existing functionality. This page aims to document major plugins that are currently available. .. note:: Refer to our :doc:`/developer/developer` for more information on how to develop (additional functionality) for metasyn. Privacy plug-ins ---------------- Disclosure control ~~~~~~~~~~~~~~~~~~ `Disclosure Control `_ is a plug-in developed in-house for metasyn. While the base ``metasyn`` package is generally good at protecting privacy, it doesn't adhere to any standard level of privacy. For example, the uniform distributions in the base package will simply find the lowest and highest values in the dataset, and use those as the boundaries for the uniform distribution. In some cases the minimum and maximum values can be disclosive. That is why we have built this plug-in that implements the disclosure control standard. Custom privacy plug-ins ~~~~~~~~~~~~~~~~~~~~~~~ If you wish to create a custom distribution plug-in, please refer to the :ref:`privacy_plugin` section on the :doc:`/developer/plugins` developer documentation page. Distribution plug-ins --------------------- It is possible to add additional distribution types through plug-ins. Unfortunately, at this moment, no additional packages with distributions are publicly available. However, we encourage developers and users to explore the possibilities and contribute their custom distributions to enrich the ``metasyn`` ecosystem further. Custom distribution plug-ins ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you wish to create a custom distribution plug-in, please refer to the :ref:`dist_plugin` section on the :doc:`/developer/plugins` developer documentation page. .. As part of the initial release of ``metasyn``, we publish two proof-of-concept plugins: one following the disclosure control guidelines from Eurostat [@bond2015guidelines], and one based on the sample-and-aggregate technique for differential .. privacy [@dwork2010differential, pp. 142]. .. Plug-ins and automatic privacy .. -------------------------------- .. In addition to the core features, the ``metasyn`` package allows for plug-ins. Packages that alter the behaviour of the parameter estimation can be installed via pip, making them accessible within metasyn. .. .. code-block:: python .. from metasyn import MetaFrame .. from metasyncontrib.disclosure import DisclosurePrivacy .. mds = MetaFrame.from_dataframe(df, privacy=DisclosurePrivacy()) .. You can read more on plugins in our :doc:`/usage/plugins` section.