nmfs-ost / nmfs-ost/stockplotr

[docs]: internal example data for all models compatible with `convert_output`

Open
#276 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I think it would be nice to include example data sets for each assessment model that is compatible with convert_output. This would require

  • example output for each compatible model
  • adjustment to GHA to convert output and add as example data (actually name based on species)
  • subset of example data to limit the amount of information and not make download of the package too large

Models:

  • SS3 (file in pkg)
  • BAM (file in pkg but not example)
  • Rceattle
  • FIMS

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 locating the existing SS3 file in the package, the BAM file, the convert_output entry point, and the GitHub Actions workflow. Review how current package data is structured and how the workflow handles conversion. Done means each compatible model—SS3, BAM, Rceattle, and FIMS—has suitably subset example data named by species without making the package download too large.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, r
Domain
ci-cd, data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.