Skip to content

API Reference

This section contains the API documentation for the devices_rap package.

It is automatically generated from the codebase using MkDocs and provides detailed information about the functions, classes, and modules used in the pipeline.

Modules

Module Description
data_in Contains utilities for loading data from various sources, such as SQL databases and CSV files.
clean_data Provides functions for cleaning and preprocessing data.
config Contains the configuration object for setting up the Amber Report Pipeline.
constants Defines constants used throughout the pipeline.
create_cuts Contains functions for cutting the data into regional datasets.
data_out Contains utilities for outputting data to various formats, such as CSV and SQL databases.
exception_notes Function to generate exception notes for the Amber Report Pipeline.
interpret_output_instructions Contains functions for processing and interpreting the output instructions for outputting the data.
joins Contains functions for joining datasets together.
pipeline Contains the main pipeline function that orchestrates the entire process.
summary_tables Contains functions for pivoting the data and generating the summary and detailed tables.