extractFmFe: Extract fm and fe values that change with time from a...

In shirewoman2/Consultancy: Standardized tools for using R within the Simcyp Consultancy Team

Extract fm and fe values that change with time from a Simulator output Excel file

Description

extractFmFe extracts fm and fe data from a simulator output Excel file. A tab named "Time variant %fm and fe" must be present to get dynamic fm and fe values, and a tab named "% fm and fe SS" must be present to get static values. Dynamic fm and fe data are required if you want to use these data with the function fm_plot to make a graph of how the fm values change over time.

Usage

extractFmFe(
  sim_data_file,
  static_or_dynamic = "dynamic",
  returnOnlyMaxMin = TRUE,
  returnAggregateOrIndiv = "both",
  existing_exp_details = NA
)

Arguments

sim_data_file	name of the Excel file containing the simulated dynamic fm and fe data, in quotes
static_or_dynamic	get "static" or "dynamic" (default) fm values. "static" will retrieve information from the "% fm and fe SS" tab, if present, and "dynamic" will retrieve it from the "Time variant %fm and fe" tab.
returnOnlyMaxMin	TRUE (default) or FALSE for whether to return only maximum and minimum fm values for dynamic fm values – basically, return the table in the upper left corner of the "Time variant %fm and fe" tab.
returnAggregateOrIndiv	Return aggregate and/or individual simulated fm and fe data? This currently only applies to the dynamic fms and has not yet been developed for the static fms, which will only return aggregate data at present. Options are "individual", "aggregate", or "both" (default). Aggregated data are not calculated here but are pulled from the simulator output rows labeled as "mean".
existing_exp_details	If you have already run extractExpDetails_mult or extractExpDetails to get all the details from the "Input Sheet" (e.g., when you ran extractExpDetails you said exp_details = "Input Sheet" or exp_details = "all"), you can save some processing time by supplying that object here, unquoted. If left as NA, this function will run extractExpDetails behind the scenes to figure out some information about your experimental set up.

Value

a data.frame

Examples

# None yet

shirewoman2/Consultancy documentation built on June 1, 2025, 6:05 p.m.