flow_data_calculation: Calculate flow data.

In lilyclements/Rapidreadr: Read Data From a RapidPro API

Calculate flow data.

Description

This function arranges flow data for different flow types.

Usage

flow_data_calculation(
  result_flow,
  flatten = FALSE,
  flow_type = "none",
  flow_handle_type = NULL,
  flow_handle_type_sub = "category",
  date_from = NULL,
  date_to = NULL,
  format_date = "%Y-%m-%d",
  tzone_date = "UTC",
  created_on = FALSE
)

Arguments

result_flow	Data frame containing flow data.
flatten	Default FALSE. A boolean denoting whether the data should be flattened into a two-dimensional tabular structure.
flow_type	Default none, option of other to specify a handle type.
flow_handle_type	Default NULL. If flow_type is other, this is the value of the flow under ⁠$value⁠ to get the response for.
flow_handle_type_sub	Default NULL. If flow_type is other, this is the group within flow_handle_type to handle.
date_from	character string giving the date to filter the data from.
date_to	character string giving the date to filter the data to.
format_date	character string giving a date-time format as used by strptime.
tzone_date	time zone specification to be used for the conversion, if one is required.
created_on	Parameter for flow_data.

Value

Data frame displaying the flow data.

lilyclements/Rapidreadr documentation built on April 17, 2025, 6:10 p.m.