Skip to content
/ ACRO Public

Tools for the Automatic Checking of Research Outputs. These are the tools for researchers to use as drop-in replacements for commands that produce outputs in Stata Python and R

License

Notifications You must be signed in to change notification settings

AI-SDC/ACRO

Repository files navigation

ACRO: Tools for the Automatic Checking of Research Outputs

DOI PyPI package Python versions Codacy codecov

This repository holds the Python ACRO package. An R wrapper package is available: ACRO-R.

ACRO (Automatic Checking of Research Outputs) is an open source tool for automating the statistical disclosure control (SDC) of research outputs. ACRO assists researchers and output checkers by distinguishing between research output that is safe to publish, output that requires further analysis, and output that cannot be published because of substantial disclosure risk.

It does this by providing a light-weight 'skin' that sits over well-known analysis tools, in a variety of languages researchers might use. This adds functionality to:

  • identify potentially disclosive outputs against a range of commonly used disclosure tests;
  • suppress outputs where required;
  • report reasons for suppression;
  • produce simple summary documents TRE staff can use to streamline their workflow.

ACRO workflow and architecture schematic

Installation

ACRO can be installed via PyPI.

If installed in this way, the example notebooks and the data files used therein will need to be copied from the repository.

$ pip install acro

Notes for Python 3.12

ACRO currently depends on an older version of Pandas (~1.5.0) for which no pre-compiled wheels are available within pip for Python 3.12. Therefore, in this scenario, Pandas must be built from source. This requires the installation of a C++ compiler before pip installing acro.

For Windows, Microsoft Visual Studio and the C++ build tools will likely need to be installed first.

Examples

See the example notebooks for:

Documentation

The github-pages contains pre-built documentation.

Training Materials

For training videos about ACRO, see training videos.

Contributing

See CONTRIBUTING.md

Acknowledgement

This work was funded by UK Research and Innovation under Grant Number MC_PC_23006 as part of Phase 1 of the DARE UK (Data and Analytics Research Environments UK) programme, delivered in partnership with Health Data Research UK (HDR UK) and Administrative Data Research UK (ADR UK). The specific project was Semi-Automatic Checking of Research Outputs (SACRO).

About

Tools for the Automatic Checking of Research Outputs. These are the tools for researchers to use as drop-in replacements for commands that produce outputs in Stata Python and R

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published