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
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_io Utilities for input/output operations, including reading, writing, and processing data.
exception_notes Functions to generate exception notes for the Amber Report Pipeline.
interpret_output_instructions Functions for processing and interpreting output instructions.
joins Functions for joining datasets together.
pipeline Main pipeline function that orchestrates the entire process.
summary_tables Functions for pivoting data and generating summary/detailed tables.