Skip to main content

ACRO: Tools for the Automatic Checking of Research Outputs

Project description

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.

A GUI for viewing and approving outputs is also available: SACRO-Viewer

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 a substantial risk of disclosing private data.

It does this by providing a lightweight '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.13

ACRO currently depends on numpy version 1.x.x for which no pre-compiled wheels are available within pip for Python 3.13. Therefore, in this scenario, numpy must be built from source. This requires the installation of a C++ compiler before pip installing acro.

For Windows, the Microsoft Visual Studio 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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acro-0.4.7.tar.gz (50.1 kB view details)

Uploaded Source

Built Distribution

acro-0.4.7-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

Details for the file acro-0.4.7.tar.gz.

File metadata

  • Download URL: acro-0.4.7.tar.gz
  • Upload date:
  • Size: 50.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for acro-0.4.7.tar.gz
Algorithm Hash digest
SHA256 115c23d98ce56220f1f6220739d3920e939a8fe991f72085a0edb3780d5ce184
MD5 4a312b89547623f1077167239143c093
BLAKE2b-256 1dfd261f758cd817c231b43efe43e0debbfe07b222f70780ee8b53f9335f70cd

See more details on using hashes here.

File details

Details for the file acro-0.4.7-py3-none-any.whl.

File metadata

  • Download URL: acro-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 33.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for acro-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 54ed513cd5c8c7ee6fe9e69b672c5e62d7bd9d0a7dff4e4b66eb00bdfe1ea9e8
MD5 a8931285e048e672f48a6fc88ae1890b
BLAKE2b-256 cd821e2ac7d46cbde68aff7a181ba3efc5e8e8988515f72688034615a2b97182

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page