nmfs-ost / nmfs-ost/stockplotr
Development Prioritization: Figures
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 19
- Forks
- 7
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 9
Description
Coding in Figures
Each of the proposed figures in the list below will be coded in as function in the R folder. I am thinking additionally there will be a function that will plot common figures together based on their categorization or type of data they are plotting.
Determining Rank
The tables and figures proposed and reviewed by the steering committee were prioritized based on the number of votes they each table or figure received. The different between positive and negative votes determined rank. Objects with a difference above 3 were categorized as P1. Below 3 but equal to or greater than 0 were designated as P2, and anything below a zero was designated as parking lot. Objects ranked at 3 were decided either to be P1 or P2 depending on comments and the developers expertise. Objects within the rank were listed in descending order of difference and objects with the same value were placed in order based on developer expertise.
The proposed list of tables and figures can be found here.
*Note: Only NOAA internal employees can access this document.
Guide:
P1: revived the highest amount of votes from the steering committee and are incorporated into almost every stock assessment used for management advice
P2: medium priority items that are important but can pushed a little bit later in development
“Parking lot”: lowest priority for development; will still be added into the package for the first release, but is not needed as soon as the other tables; received lowest amount of votes/negative votes
() = category
D = data
ES = executive summary
AM = assessment mode
P = projections
High Priority (P1)
- Landings (D): Cumulative area time series plot; by fleet
- CPUE indices (D): Line graph with CIs; strat. By survey/fleets
- Estimated recruitment (AM): line graph with error bars
- Biomass time series (ES & AM): Line graph with biomass reference point as horizontal dashed line
- Spawning biomass time series (AM): line graph
Medium Priority (P2)
- F or exploitation rate time series (ES): Line graph; F reference point as dashed line
- Recruitment deviations time series (AM)
- Kobe plot (ES): base model and any sensitivity models (most likely only base model)
- Model fit to abundance (N) or fishing effort (AM)
- Projections (P)
- Model fit to catch time series (AM): Line graph?; by fishery and/or gear
- vonB length at age (D): Points + line graph for model fit; potentially stratified by area, gender, ect.
- Catch at length (D): Histogram; by year, fleet, or FI survey
Lowest Priority
- W/L conversion (D): Points + fitted curve, R sq. value and eqtn
- #62
- #60
- Maturity schedule (D)
- #68
- #66
- Fecundity at age (D): if applicable
- Catchability (q) time series (AM): line graph; only if time varying
- Length type conversion (D): Ex: TL to FL; raw points with linear fit, R sq. value, and resulting eqtn.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposed figures list in the issue and inspect the R folder to determine which unchecked P2 and lowest-priority items already have corresponding functions. The linked prioritization document requires NOAA internal access, so confirm scope and acceptance criteria before implementing any figures or a common plotting function. Done means the selected figures are implemented and their checklist items can be marked complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- data-visualization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100