Skip to content

[feat] Add new template "type" for SEDAR reports - #511

Open
sbreitbart-NOAA wants to merge 5 commits into
mainfrom
sedar-type
Open

[feat] Add new template "type" for SEDAR reports#511
sbreitbart-NOAA wants to merge 5 commits into
mainfrom
sedar-type

Conversation

@sbreitbart-NOAA

@sbreitbart-NOAA sbreitbart-NOAA commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

What is the feature?

  • Add new template "type" for SEDAR reports, based off three reports: SEDAR 72, SEDAR 85, SEDAR 81
  • Update citation-making process so that if type = SEDAR or office = SEFSC, citation is SEDAR-specific

How have you implemented the solution?

  • Updating create_template() and create_yaml()
  • Adding new template for SEDAR to templates folder

Does the PR impact any other area of the project, maybe another repo?

  • No

@sbreitbart-NOAA sbreitbart-NOAA linked an issue Jul 10, 2026 that may be closed by this pull request
@github-actions

Copy link
Copy Markdown
Contributor

New version checklist

  • Package version in DESCRIPTION has been updated
  • Release notes have been drafted/published
  • Cheatsheet content has been updated (if applicable)
  • Cheatsheet version has been updated

@github-actions

Copy link
Copy Markdown
Contributor

Checklist

  • PR base branch is accurate
  • Is the code concise?
  • Comments are clear and useful.
  • Can you remove or combine any arguments?
  • Do argument contain defaults (if appliable)?
  • Code is documented and example provided (Roxygen).
  • Did you make a test (testthat)?
  • Was this tested under multiple scenarios?
  • Did you run devtools::check()?

@github-actions

Copy link
Copy Markdown
Contributor

Code Metrics Report

Coverage Code to Test Ratio Test Execution Time
37.3% 1:0.2 36s

Code coverage of files in pull request scope (41.4%)

Files Coverage
R/create_template.R 40.2%
R/create_yaml.R 47.2%

Reported by octocov

Comment thread R/create_template.R Outdated

@Schiano-NOAA Schiano-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.

This is looking good, but it makes me wonder if this is needed. If there is no actual template, it might be worth more socializing that they are the same. The PR would then only make changes when office = "SEFSC" for authorship in the yml

@Schiano-NOAA

Copy link
Copy Markdown
Collaborator

@sbreitbart-NOAA please also make changes to the citation. Idk how involved that will be, but it still inputs author and I think this doesn't align with SEDAR? Not sure though

@sbreitbart-NOAA

Copy link
Copy Markdown
Collaborator Author

@lisaailloud-NOAA We are adding a report template that emulates a typical SEDAR report structure. Could you please take a look at the qmd files within the 'inst/templates/sedar' folder and let us know how we could improve the report structure, if at all?

@lisaailloud-NOAA

Copy link
Copy Markdown
Collaborator

Thanks! The structure matches well with what we've been doing in the Gulf but I looked at the Atlantic side's reports (e.g. SEDAR92) and they are quite different. However, I don't think there's a way to make it work for every case.. Has your approach with other regions to include more or include less? I could set up a meeting to discuss this with representatives from all three branches?

The only thing I would remove in the meantime is "constant catch" in the 06_projections qmd since we can put that under the OFL / ABC header.

@sbreitbart-NOAA

Copy link
Copy Markdown
Collaborator Author

@lisaailloud-NOAA - thank you for your feedback! I can remove the "constant catch" part.

@Schiano-NOAA Since you set up the other templates, do you have any thoughts re: Lisa's comment about how to make a template that works across a region, as this template is currently better suited for the Gulf vs. Atlantic?

@Schiano-NOAA

Copy link
Copy Markdown
Collaborator

@sbreitbart-NOAA @lisaailloud-NOAA I think setting up a meeting with reps from all 3 regions would be best. Then we can at least come to an agreement on an outline for SEDAR if the standard guidelines cannot be adopted at this time.

@lisaailloud-NOAA

Copy link
Copy Markdown
Collaborator

That sounds good. I'll look through their reports and compare with the guidelines. I'm thinking it might be easier for everyone to move to the standard guidelines rather than trying to make a SEDAR outline that works for all.. but I'll think on it and set up a meeting.

@Schiano-NOAA

Copy link
Copy Markdown
Collaborator

@lisaailloud-NOAA Agreed! Maybe this push is needed then for the standard guidelines

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.

Make "type" for SEDAR reports in create_template [Feature]: Set authorship for SEFSC reports to office rather than author

3 participants