Generate summary statistics — generate_sum

This function generates summary statistics of input and output values of a probabilistic analysis.

Usage

generate_sum_stats(
  df,
  v_params = NULL,
  x = NULL,
  y = NULL,
  xmax = max(df[, x]),
  xmin = min(df[, x]),
  ymax = max(df[, y]),
  ymin = min(df[, y])
)

Arguments

df: a dataframe.
v_params: character or vector of character. Vector of names of the variables of `df` for which to return summary statistics. Default is NULL which returns summary values for all inputs and outputs in the dataframe.
x: character string. Name of the first variable used to select a range of outcomes.
y: character string. Name of the second variable used to select a range of outcomes.
xmax: numeric. Maximum value the `x` variable can have (inclusive).
xmin: numeric. Minimum value the `x` variable can have (inclusive).
ymax: numeric. Maximum value the `y` variable can have (inclusive).
ymin: numeric. Minimum value the `y` variable can have (inclusive).

Value

A dataframe with summary data for the selected variables.

Examples

# Generating summary data of all inputs using the example dataframe
data(df_pa)
df_summary <- generate_sum_stats(df_pa)