left_addition: Add values from two module objects

In covid-19-Re/estimateR: Reproductive number estimation from delayed observations of infections

Add values from two module objects

Description

The offset of the output object is the minimum offset between input_a and input_b.

Usage

left_addition(input_a, input_b)

Arguments

input_a

Module input object. List with two elements: A numeric vector named values: the incidence recorded on consecutive time steps. An integer named index_offset: the offset, counted in number of time steps, by which the first value in values is shifted compared to a reference time step This parameter allows one to keep track of the date of the first value in values without needing to carry a date column around. A positive offset means values are delayed in the future compared to the reference values. A negative offset means the opposite.

input_b

Module input object. List with two elements: A numeric vector named values: the incidence recorded on consecutive time steps. An integer named index_offset: the offset, counted in number of time steps, by which the first value in values is shifted compared to a reference time step This parameter allows one to keep track of the date of the first value in values without needing to carry a date column around. A positive offset means values are delayed in the future compared to the reference values. A negative offset means the opposite.

Value

Module input object. List with two elements:

1. A numeric vector named values: the incidence recorded on consecutive time steps.

2. An integer named index_offset: the offset, counted in number of time steps, by which the first value in values is shifted compared to a reference time step This parameter allows one to keep track of the date of the first value in values without needing to carry a date column around. A positive offset means values are delayed in the future compared to the reference values. A negative offset means the opposite.

covid-19-Re/estimateR documentation built on Sept. 14, 2024, 5:49 a.m.