trim.input: Trim the 'input' object

Description Usage Arguments See Also

Description

When running a simulation, it is best to set the input to contain vectors longer than what is needed to store all of the information. After running the simulation, the trim.input function can be used to trim off the unused elements.

Usage

1
2
3
4
5
trim.input(input_object, trim_excess_time = NULL, dims = NULL)

## S4 method for signature 'input'
trim.input(input_object, trim_excess_time = NULL,
  dims = NULL)

Arguments

input_object

An object of class input.

trim_excess_time

A numeric value. Events and responses that occur later than some specified time are also trimmed. Defaults to NULL which means that only the NaN valus are trimmed.

dims

A character vector specifying the variables of the input object to keep. Defaults to NULL which means that all variables are kept.

input_object

A input object.

See Also

class.input

tidy.simulation_data which uses trim.input.


Don-Li/CAB_original documentation built on May 6, 2019, 2:53 p.m.