Documentation: Read-Only parameters ("Active Binding is Read Only")

[efletcherPIFSC]

Some Keyword Parameters Classes have "Read-Only" parameters primarily to keep the data structure of agepro_model.

Spare Documentation led to some user issues. Needing for clarification.

---

List of "Read Only" Bindings

agepro_model

• inp_filename AGEPRO input file path

general_param (General Parameters)

agepro_model's General Parameters contain important attributes that can only be set at model's initialization (or when read from input file).
They emulate the AGEPRO-GUI style behavior of "setting" the model with these values.

• yr_start First Year Of Projection
• yr_end Last Year Of Projection
• age_begin First Age Class
• age_end Last Age Class
• num_pop_sims Number of Population Simulations
• num_fleets Number of Fleets
• num_rec_models Recruitment Models
• discards_present Discards Present?
• seed Pseudo Random Number Seed

A new model must be initialized (or read) to set new general parameter values.

mortality_fraction Mortality Fraction prior to spawn t

TODO: Reconsider a setter for natural_mortality_prior_spawn and fishing_mortality_prior_spawn

• natural_mortality_prior_spawn The proportions of Natural mortality (TM) that occurs from January 1st to Spawning Season.
• fishing_mortality_prior_spawn Within-year fractions of fishing mortality (TF) that occurs from January 1st to Spawning Season

recruitment

• recruit_model_num_list The List of "Recruitment Model Data"
• number_recruit_models Recruitment's count of recruitment models

[dendroica]

thank you for this clarification; I'd add what perhaps falls under a feature request to allow these values to be updated after reading in the input file. The workflow I'm working on is for an update assessment, where I'm reading in an old AGEPRO file from the last benchmark, but need to add a few more years to the assessment. I've done this all manually through the AGEPRO-GUI for the assessment itself, but saw the utility of this package to be able to code the creation of the new AGEPRO model in R, using the previous assessment's model as a template to then edit/update the values for the assessment update