Skip to content

[docs]: add example data for compatible models - #427

Open
Schiano-NOAA wants to merge 5 commits into
mainfrom
docs-pkg-ex-data
Open

Schiano-NOAA wants to merge 5 commits into
mainfrom
docs-pkg-ex-data

Conversation

@Schiano-NOAA

Copy link
Copy Markdown
Collaborator

Adding example data for each model compatible with convert_output()

repository: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name || github.repository }}
ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref || github.ref_name }}

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
@Schiano-NOAA
Schiano-NOAA added this pull request to stack #430 October 19, 2026 20:32
@github-actions

Copy link
Copy Markdown
Contributor

Code Metrics Report

Coverage Code to Test Ratio Test Execution Time
75.3% 1:0.2 6m25s

Reported by octocov

remotes::install_github("afsc-assessments/Rceattle")
# library(Rceattle)
# library(readxl)
Rceattle::data("GOApollock")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get this error when running locally:

Error: 'data' is not an exported object from 'namespace:Rceattle'

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm I will test again because idk what it could be from if not.

Comment thread data-raw/DATASET_SS3.R
@@ -0,0 +1,13 @@
## code to prepare `ss3_simple` dataset goes here

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works fine but I think the documentation (and filename) should be edited to clarify that this isn't converting raw SS3 output-- instead, SS3 output that's been formatted into a list by r4ss. Filename could be updated to something like "DATASET_SS3-r4ss.R", esp. if we're planning to retain the original "DATASET.R" file, which is also based on SS3 output

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second question: are we retaining "DATASET.R"? I suppose we should, until SS3 output conversion is offically deprecated

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep right on the nose

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds >10 MB to the package. Can we reduce its size? Or will its size not impact package loading?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am currently looking into different approaches. I also need to add documentation for each dataset as an md file

@sbreitbart-NOAA sbreitbart-NOAA left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things to discuss and adjust before merging. Thanks for getting this started- it'll definitely make the package stronger!

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants