create_fsl_quality_report: Create FSL Quality Report

In SaeedR1987/healthyr: REACH Nutrition & Health R Tools

Create FSL Quality Report

Description

This function summarizes key indicators for food security outcome indicators to help the analyst assess the overall FSL data quality. This summary is intended for FSL outcome indicators only, focusing on FCS, HHS, rCSI, HDDS, and LCS indicators. This function also calls a helper function 'healthyr::calculate_plausiblity_report' to assign penalty scores and recommend an overall quality level for the FSL data.

Usage

create_fsl_quality_report(
  df,
  grouping = NULL,
  short_report = NULL,
  file_path = NULL
)

Arguments

df	Inputs a data frame that includes FSL outcome data that has already been processed and standardized by the format_nut_health_indicators function.
grouping	Inputs an optional character value specifying a column by which to group or aggregate the results by.
short_report	Inputs a boolean value TRUE or FALSE to return just key variables. If FALSE, returns a dataframe of all the variables calculated.
file_path	Inputs an optional character value specifying the file location to save a copy of the results.

Value

Returns a dataframe of a summary table of the quality indicators.

Examples

## Not run: create_fsl_report(df = proc_fsl1, grouping = "enum",
file_path = "folder/qualityreport.xlsx")
## End(Not run)

SaeedR1987/healthyr documentation built on July 4, 2023, 11:17 p.m.