Skip to content

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

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

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

Conversation

@sbreitbart-NOAA

Copy link
Copy Markdown
Collaborator

What is the feature?

  • Add new template "type" for SEDAR reports, with reports identical to skeleton except author = SEDAR only (no scientists' names added)

How have you implemented the solution?

  • Updating create_template() and create_yaml()

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

…skeleton except author = SEDAR only (no scientists' names added)
Comment thread R/create_template.R Outdated
if (rerender_skeleton){
current_folder <- subdir
} else {
current_folder <- file.path(asar_folder,

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.

It's the same? I'm wondering if this is the case, then we remove functionality for type = "SEDAR" and socialize that the standard guidelines match SEDAR reports already and set the authorship part in the yaml to activate when office = "SEFSC" instead.

What assessments did you look at to determine this is the same? With the hesitation we got, I assumed there would be some differences.

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.

This suggestion came from the SEFSC workshop, in the context of the authorship difference. I don't think the intent was to provide a report that matched the SEDAR structure since it seems highly different from the SAR.

I can change this PR to remove "type" and instead update authorship when office = SEFSC 👍

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.

Ah okay that makes this much more clear. This LGTM then. I did not run a test on it so let me do that then I will approve

@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

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

2 participants