daa_analytics_params: Standardized package function parameter definitions

In pepfar-datim/daa-analytics: Utilities for Compiling and Analyzing PEPFAR Data Alignment Activity Data

Standardized package function parameter definitions

Description

Standardized package function parameter definitions

Usage

daa_analytics_params(
  aggregate_indicators,
  aws_s3_bucket,
  cache_path,
  coc_metadata,
  combined_data,
  d2_session,
  daa_indicator_data,
  dataset_name,
  de_metadata,
  df,
  fiscal_year,
  geo_session,
  grouping_columns,
  include_coc,
  max_cache_age,
  ou_hierarchy,
  ou_metadata,
  ou_uid,
  pe_metadata,
  pvls_emr,
  pvls_emr_raw,
  weighting_name,
  weights_list,
  ...
)

Arguments

aggregate_indicators	Indicates whether indicators should be rolled up across "Age" and "Age Aggregate" data elements. Also will filter out certain data elements from 2017 and 2018 that would cause duplication.
aws_s3_bucket	The URL for the particular bucket being accessed.
cache_path	Path to the cached file to be checked.
coc_metadata	Dataframe containing category option combination metadata.
combined_data	Dataframe containing adorned DAA indicator data combined with PVLS & EMR data.
d2_session	R6 session object.
daa_indicator_data	Dataframe containing DAA indicator data.
dataset_name	The name of the dataset to be returned from S3.
de_metadata	Dataframe containing data element metadata.
df	Dataframe containing data to be adorned.
fiscal_year	List of fiscal years starting in October to be included.
geo_session	R6 session object specifically for a DHIS2 GeoAlign session.
grouping_columns	A list of columns on which weighting groups should be based.
include_coc	Boolean indicating whether Category Option Combo data should be kept or removed from returned dataset.
max_cache_age	Maximum age at which the cache is considered "fresh".
ou_hierarchy	Dataframe containing DATIM organisation unit hierarchy.
ou_metadata	Dataframe containing organisation unit metadata.
ou_uid	UID for the Operating Unit whose data is being queried.
pe_metadata	Dataframe containing period metadata.
pvls_emr	Dataframe of PVLS and EMR data joined with metadata.
pvls_emr_raw	Unadorned dataframe of PVLS and EMR indicator data.
weighting_name	Name to be given to weighting column.
weights_list	A list containing the levels at which concordance metrics should be calculated. OU level is the default, calculating sites as a share of the overall country. SNU levels 1-3 are supported, as well as EMR, which groups by whether or not a facility has an EMR.
...	Additional arguments to pass.

Value

list of all parameters of this constructor function

pepfar-datim/daa-analytics documentation built on Nov. 24, 2024, 7:31 p.m.