Lookup a series of transitions connecting two dates or timesteps
Source:R/lookup_transitions.R
lookup_transitions.Rd
The private functionlookup_transitions()
returns an ordered vector of
transition names that connect start to end. If start
and end
are dates
than their order determines whether the transitions flow forward or backward
in time. If they are timesteps than the direction
argument should be used
to indicate whether to project "forward" or "backward" in time possibly
passing the year boundary.
Arguments
- ...
Arguments passed on to
lookup_timestep_sequence
season
a season name, season alias, or "all". See
lookup_season_timesteps()
for options.start
The starting point in time specified as a timestep, character date, or date object.
end
The ending point in time as a date or timestep.
direction
Either "forward" or "backward" defaults to
"forward"
if not processing dates. If using date inputdirection
is optional and is only used to verify the direction implicit in the dates.season_buffer
Only used with
season
input.season_buffer
is passed tolookup_season_timesteps()
and defaults to 1; it is the number of timesteps to extend the season by at each end.n_steps
Alternative to
end
The end will ben_steps
away fromstart
indirection
; and the resulting sequence will haven_step
transitions andn_steps + 1
timesteps.