R/Definitions.R
formatOutput.Rd
The function removes duplicated columns, orders the columns as per the order defined by getDataTypeDefinition
, optionally removed undefined columns, orders the rows, and finally deletes any data.table keys from the output tables.
formatOutput(
data,
dataType,
keep.all = TRUE,
allow.missing = FALSE,
primaryColumnOrder = NULL,
secondaryColumnOrder = NULL,
secondaryRowOrder = NULL,
removeStoXKeys = FALSE
)
A table or list of tables to return from the StoX function.
The data type to format against.
Logical: If TRUE keep all columns, and if FALSE delete undefined columns.
Logical: If TRUE allow for unrelevant column names defined in secondaryColumnOrder
.
Character: A vector of names of columns that should be placed first regardless of the definition of columns specified in the dataTypeDefinition.
A vector of column names specifying order of column not defined by getDataTypeDefinition
used to prioritize when ordering columns and rows, respectively.
Logical: If TRUE remove the key columns, which are those ending with "Key".