Skip to contents

Set phase

Source: R/set_season_phase.R
set_season_phase.Lambda.Rd

Set the phase for the seasonal pattern for the \(s^{th}\) species and return the ramp.xds model object

Usage

# S3 method for class 'Lambda'
set_season_phase(phase, xds_obj, s = 1, compile_F = TRUE)

Arguments

phase

the new phase parameter

xds_obj

a ramp.xds model object

s

the vector species index

compile_F

if true, call update_F_season

Value

the ramp.xds model object with an updated phase parameter