Learn R Programming

invivoPKfit (version 2.0.1)

convert_time: Helper function to convert time units

Description

Convert a vector of times between units

Usage

convert_time(x, from = "hours", to = "identity", inverse = FALSE)

Value

A numeric vector the same length as `x`, converted from the units in `from` to the units in `to`.

Arguments

x

Numeric: one or more time values to be converted.

from

Character vector: `x` is currently in these units. Must be units understood by `lubridate::duration()`, i.e. `"seconds"`, `"hours"`, `"days"`, `"weeks"`, `"months"`, `"years"`, `"milliseconds"`, `"microseconds"`, `"nanoseconds"`, and/or `"picoseconds"`. Default value is `"hours"`.

to

Character vector: `x` will be converted to these units. Must be either `"auto"`, `"identity"`, or units understood by `lubridate::duration()`, i.e. `"seconds"`, `"hours"`, `"days"`, `"weeks"`, `"months"`, `"years"`, `"milliseconds"`, `"microseconds"`, `"nanoseconds"`, and/or `"picoseconds"`. Default value is `"identity"`. If `"identity"`, then `x` will be returned unchanged. If `"auto"`, then units will be automatically chosen that make the midpoint of `x` (or its inverse, if `inverse = TRUE`) as close to an order of magnitude of 10 as possible (see [auto_units()]).

inverse

Logical: TRUE if `x` is in units of *inverse* time (e.g. 1/hour, 1/day); FALSE if `x` is in units of time (e.g. hours, days). Default value is FALSE.

Author

Caroline Ring, Gilberto Padilla Mercado