Skip to contents

Calculate Flows

Usage

calculate_flows(
  df_order,
  input,
  shares_timeseries_wide = NULL,
  config,
  use_dynamic = FALSE,
  return_inputs = FALSE,
  debug = TRUE
)

Arguments

df_order

list for each order id (corresponding to same level of distance of section from selected outflow)

input

input flows as retrieved by prepare_input and sublist "flows"

shares_timeseries_wide

shares timeseries in wide format, as retrieved by prepare_input and sublist "shares_timeseries" (default: NULL), only used if parameter "use_dynamic" is set to TRUE

config

list with config as imported with config_read

use_dynamic

for multiple outputs only: should static shares (as defined in column "section_out_share" of "outflows_multiple.csv") be used for separating the flow within a section or a function (as defined in column "section_out_function" of "outflows_multiple.csv")), (default: FALSE)

return_inputs

should also input data be returned in result dataset (default: FALSE)

debug

print debug messages (default: TRUE)

Value

returns modelled flows in tibble format