audit_measure: Creates a new audit_measure object

In md0u80c9/SSNAPStats: Stroke Sentinel National Audit Project (SSNAP) Statistics Calculations

Description

This family of functions are used to create a new audit_measure object. Audit measure objects have two subclasses: audit_measure_continuous and audit_measure_discrete. You can create both using the audit_measure function (to allow us to create multiple objects at once, for example from a script).

Usage

audit_measure(stem_name, description, exclusions = NULL, numerators,
  numerator_descriptors = NULL, is_key_indicator = FALSE,
  reference_id = NULL, csv_columns = NULL,
  measure_type = c("discrete", "continuous"))

audit_measure_continuous(stem_name, description, exclusions = NULL,
  numerators, numerator_descriptors = NULL, csv_columns = NULL)

audit_measure_discrete(stem_name, description, exclusions = NULL,
  numerators, numerator_descriptors = NULL, csv_columns = NULL)

Arguments

stem_name	The name of the new audit measure
description	A short textual description of what the audit measure is intended to measure.
exclusions	Any exclusions from the population expressed as an expression.
numerators	One or more numerators for the measure. This is either the variable if we are looking at a continuous measure, or the pass / fail criteria expressed as a boolean expression. Results can be broken down by using a series of numerators.
numerator_descriptors	A descriptor for each numerator. These are optional but if you provide one you must provide one for every numerator.
is_key_indicator	Is this measure a key indicator?
reference_id	A unique reference number for this audit measure. Different audits use different reference schemes. We don't use this reference for calculations, but it is included in metadata and may be used for some of the outputs.
csv_columns	a character vector of all the columns from the raw CSV file needed to make this audit measure.
measure_type	Describes the type of variable - whether it is discrete (usually TRUE/FALSE), or continuous (where medians and quartiles may be used to describe the output).

Details

Audit measure objects describe the rules which will be applied to a cohort to derive a set of aggregated output measures. The denominator for these measures will be the cohort that they are applied over.

Any exclusions from the cohort are specified in exclusions. Each measure can have one or more numerators. This allows measures to be described in groups or a breakdown of results into categories.

Value

The created audit_measure object.

md0u80c9/SSNAPStats documentation built on Feb. 11, 2020, 11:43 a.m.