Examples#

This section provides comprehensive examples and tutorials for using the ACRO family of tools.

Getting Started

Interactive Notebooks#

Python Jupyter Notebooks#

ACRO Tests - Introduction to ACRO with the charities dataset
ACRO Demonstration - Complex analysis with the nursery dataset

R Notebooks#

ACRO-R Quickstart - Getting started with ACRO in R
Statistical Modeling in R - Advanced R workflows

Video Tutorials#

Example Datasets#

The following datasets are available for testing and learning:

Charities Dataset#

A synthetic dataset containing information about charitable organizations, including:

Organization details (name, type, region)
Financial information (income, expenditure)
Activity classifications

Usage: Ideal for learning cross-tabulation and basic statistical analysis

Nursery Dataset#

A classification dataset for nursery school applications, featuring:

Categorical variables (parents, has_nurs, form, children, housing, finance, social, health)
Target variable (spec_prior, priority, not_recom)

Usage: Perfect for statistical modeling and regression examples

Sample Code Repository#

All example code is available in the ACRO Examples Repository.

# Clone examples repository
git clone https://github.com/AI-SDC/ACRO-Examples.git
cd ACRO-Examples

# Install requirements
pip install -r requirements.txt

# Run Jupyter notebooks
jupyter notebook

Common Use Cases#

Research Workflow Examples#

Exploratory Data Analysis
- Safe data exploration and summarization
- Identifying patterns while protecting privacy
- Generating publication-ready tables
Statistical Modeling
- Regression analysis with disclosure control
- Model comparison and selection
- Coefficient interpretation and reporting
Advanced Statistical Analysis
- Complex regression modeling
- Survival analysis with disclosure control
- Custom statistical procedures

TRE Integration#

ACRO integrates with Trusted Research Environments (TREs) to provide:

Automated output submission to approval workflows
Integration with existing TRE systems and security protocols
Multi-user support with shared configuration management
Audit trails for compliance and tracking

Best Practices Examples#

Configuration Management
- Environment-specific settings
- Threshold customization
- Policy compliance
Quality Assurance
- Reproducible analysis workflows
- Version control integration
- Documentation standards

Getting Help#

If you need help with any examples:

Check the API Reference for detailed function documentation
Visit our GitHub Issues page
Join our community discussions
Contact support: acro-support@ai-sdc.org

Contributing Examples#

We welcome contributions of new examples and tutorials:

Fork the ACRO Examples Repository
Create a new example following our template
Test your example thoroughly
Submit a pull request with documentation

Example Template#

"""
Example Title: Brief Description

This example demonstrates [specific functionality].

Requirements:
- acro >= 0.4.8
- pandas >= 1.5.0

Dataset: [dataset name and source]
Difficulty: [Beginner/Intermediate/Advanced]
"""

import acro
import pandas as pd

# Example code here...