ards (version 0.1.3)

add_ards: Adds data to an Analysis Results Dataset

Description

The add_ards function dumps data from an input analysis dataset to the ARDS dataset. The function is designed to be pipe-friendly, and will return the input dataset unaltered. The parameters on the function define how to extract the desired data from the analysis dataset. The "statvars" parameter defines which columns contain desired analysis results. The values in these columns will be used to populate the "statval" variable in the output dataset. Other parameters are used to define identifying information for the statistics values, and are optional.

The add_ards function should be called immediately after any calculations, while the analysis results are still in numeric form. This recommendation is to ensure that the ARDS will contain full precision of the analysis values. Once the analysis values are dumped into the ARDS, you may proceed to transform and format your analysis data, without affecting the values captured in the ARDS.

Usage

add_ards(
  data,
  statvars,
  statdesc = NULL,
  byvars = NULL,
  trtvar = NULL,
  paramcd = NULL,
  anal_var = NULL,
  anal_val = NULL
)

Value

The input data frame, unaltered.

Arguments

data

The input data to create analysis results for. This parameter is required.

statvars

A vector of column names that identify the desired results. Statvar columns must be numeric. This parameter is required.

statdesc

A vector of values or a column name that identifies a description for each statvar. If passed as a vector of values, the number of values should correspond to the number of 'statvar' variables.

byvars

A vector of column names to use for by variables.

trtvar

A column name to use for the treatment variable.

paramcd

A character string that describes the analysis parameter code or column name that contains the parameter code. If supplied as a column name, the function will populate the 'paramcd' column in the ARDS with the value of the 'paramcd' column.

anal_var

A column name for the analysis variable or a string that identifies the analysis variable.

anal_val

The analysis variable value. Can be identified by a column name or a vector of values. By default, the analysis values will be taken from the values of the variable passed in 'anal_var'. This parameter exists so that you may pass in the values from a different variable, if desired.

See Also

Other ards: get_ards(), init_ards(), restore_ards()

Examples

library(ards)
library(dplyr)

# Initialize the ARDS
init_ards(studyid = "MTCARS",
          tableid = "01", adsns = "mtcars",
          population = "all cars",
          time = "1973")

# Perform analysis on MPG
# - Add to ARDS from within continuous variable pipeline
mpgdf <- mtcars |> 
  select(cyl, mpg) |> 
  group_by(cyl) |> 
  summarize(n = n(),
            mean = mean(mpg),
            std = sd(mpg),
            min = min(mpg),
            max = max(mpg)) |> 
  add_ards(statvars = c("n", "mean", "std", "min", "max"),
         anal_var = "mpg", trtvar = "cyl")
            
# Perform analysis on GEAR
# - Add to ARDS from within categorical variable pipeline
geardf <- mtcars |> 
  mutate(denom = n()) |> 
  select(cyl, gear, denom) |> 
  group_by(cyl, gear) |> 
  summarize(cnt = n(), 
            denom = max(denom)) |>
  mutate(pct = cnt / denom * 100) |> 
  add_ards(statvars = c("cnt", "pct", "denom"),
         anal_var = "gear", trtvar = "cyl")

# Get the ARDS
ards <- get_ards() 

# Uncomment to view ards
# View(ards)