nmfs-ost / nmfs-ost/stockplotr

[Feature] SPR time series (AM)

Open
#226 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

development
Dominant language
R
Stars
19
Forks
7
Avg merge
2d 13h
Merged PRs (30d)
9

Description

One of the high priority figures for development in {stockplotr} is an spr timeseries figure. We do not have a current example for this so the developer for this table has some free rein to choose the design and quantities.

Start: look at the variety of spr figures available

Next: work on setting up a branch (feat-plot-spr) and a new function called plot_spr() for this table. Please follow the branch and PR indicators. There are instructions in the CONTRIBUTING.md that describe how each table or figure are set up and the steps/related functions that can create it.

Last: set up a testing framework using {testthat} to test the function.

@Schiano-NOAA or @sbreitbart-NOAA can run tests on the function to ensure it is compatible with all models that are compatible in the convert_output function. (We are planning on adding test data sets to the package for all models in the future.)

Please complete what you are able to do and the package maintainers can pick up where you left off.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the variety of SPR figures and the figure and table development guide in CONTRIBUTING.md. Set up the feat-plot-spr branch and define the plot_spr() function, then use testthat to test it against models compatible with convert_output. Done means the function and testing framework are in place for maintainers to verify compatibility and continue the work.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.