Recruitment: redundant/ambiguous use of seq_yrs

[efletcherPIFSC]

Use of redundant or ambiguous use of sequence years in recruitment

• public field seq_yrs : Sequence of projected years
• Recuitment initializes with seq_years
  • Shared param description template of seq_years: Array representing the Projection Time Horizon
• Uses seq_years as a parameter to set recruit data (set_recruit_data).
  • sends seq_years to private$assert_seq_years to handle seq_years as a single int or a vector of sequential values
• assert_seq_years uses seq_years as parameter
  • in private$assert_seq_years, assign self$seq_years <- seq_years
  • if self$seq_yrs is a single int:
  • assign private$.qty_seq_years to self$seq_years value
  • and private$.req_seq_years from 1 to self$seq_years
  • else
  • assign private$.qty_seq_years to self$seq_years value
  • and private$.req_seq_years from 1 to self$seq_years
• private$.qty_seq_years is number of sequential projection years
  • [For each Recruit] Is used to generate default equal distribution of recruitment probability per projection year,
  • previously known as num_rec_seq
• private$.req_seq_years is the sequential projection year names used as array index names of recruitment probability
  • Previosuly known as seq_yr_array
• [For each recruit] use self$seq_yrs to setup recuitment model data (set_recruit_model).

Solutions

• Trace usage of self$seq_yrs passed into set_recruit_model
• rename seq_yrs to observation_years (ala AGEPRO-CoreLib AgeproRecruitment.cs)
• rename and clarify .qty_seq_years, and .req_seq_years