aggregateBaselineDataOneTableSingleFunction | R Documentation |
Function to aggregate baseline data
aggregateBaselineDataOneTableSingleFunction(
stoxData,
subTable = character(),
TargetVariable,
ReportFunction = getReportFunctions(),
GroupingVariables = character(),
InformationVariables = character(),
na.rm = FALSE,
padWithZerosOn = character(),
Specification = list(),
uniqueGroupingVariablesToKeep = NULL
)
stoxData |
Output from any StoX function. |
subTable |
The name of the sub table to aggregate on, if |
TargetVariable |
The variable to report. |
ReportFunction |
The name of a function to report the Baseline process output by. This must be a function returning a single value. See |
GroupingVariables |
The variables to report by. For most applications |
InformationVariables |
Variables to include as columns to the end of the report table. These cannot have more unique combinations than the |
na.rm |
Used in the function specified by |
padWithZerosOn |
Character vector giving the variables for which missing values should be padded with zeros. This is used particularly for bootstrapping, where a fish length missing in a bootstrap run should be considered as samples with zero individuals, and not missing, so that summary statistics end up taking all bootstrap replicates into account (if not a mean would be overestimated). When padWithZerosOn has positive length, padding with zeros is applied to this variable and to the |
Specification |
A named list of specification parameters used in the |
uniqueGroupingVariablesToKeep |
A data.table holding unique combinations to extract from the data, used by RstoxFramework::ReportBootstrap() to discard combinations of the grouping variables what do not exist in the data. Such combinations are introduced with the CJ operation when padWithZerosOn is given. |
An aggregated version of the input stoxData
.
ReportSuperIndividuals
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.