tidytlg (version 0.11.0)

generate_results: Generate Results using Table and Column Metadata

Description

Generate Results using Table and Column Metadata

Usage

generate_results(
  table_metadata,
  column_metadata_file = NULL,
  column_metadata = NULL,
  env = parent.frame(),
  tbltype = NULL,
  add_count = FALSE
)

Value

dataframe of results

Arguments

table_metadata

a data frame containing table metadata (see ?table_metadata for details)

column_metadata_file

An excel file with the data for column_metadata. The file is read in with readxl::read_excel(). Should not be used with column_metadata argument. Results in a data frame containing the column metadata that is passed to tlgsetup (see tlgsetup() for details). If a column_metadata data frame is passed in too, this is ignored.

column_metadata

A data frame containing the column metadata. This will be used in place of column_metadata_file.

env

environment to find data frame specified in the table metadata (defaults to parent environment).

tbltype

If used, this will be used to subset the column_metadata based on the tbltype column.

add_count

Passed to bind_table() should counts be added for tablebyvars?