Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add acronyms #122

Draft
wants to merge 42 commits into
base: dev
Choose a base branch
from
Draft

Add acronyms #122

wants to merge 42 commits into from

Conversation

sbreitbart-NOAA
Copy link
Collaborator

What is the feature?

  • Capability to reference acronyms and their meanings in an asar report

How have you implemented the solution?

  • Adding the list of acronyms and meanings, plus the code needed to implement functionality with latex

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

  • No

Copy link
Contributor

github-actions bot commented Jan 6, 2025

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

@sbreitbart-NOAA sbreitbart-NOAA changed the base branch from main to dev-1.1 January 6, 2025 15:06
@kellijohnson-NOAA
Copy link
Collaborator

I briefly looked at the list and think that all of the used assessment platforms should be added, e.g., BAM - Beaufort Assessment Model, WHAM Woods Hole Assessment Model, JABBA Just Another Bayesian Biomass Assessment, ASAP Age Structured Assessment Program, AMAK Assessment model for Alaska, CEATTLE Climate enhanced Age-based model with Temperature specific Trophic linkages and Energetics. I am sure there are others but this would be a good start.

@sbreitbart-NOAA
Copy link
Collaborator Author

I briefly looked at the list and think that all of the used assessment platforms should be added, e.g., BAM - Beaufort Assessment Model, WHAM Woods Hole Assessment Model, JABBA Just Another Bayesian Biomass Assessment, ASAP Age Structured Assessment Program, AMAK Assessment model for Alaska, CEATTLE Climate enhanced Age-based model with Temperature specific Trophic linkages and Energetics. I am sure there are others but this would be a good start.

Thanks, Kelli! Just added these to the list.

@Schiano-NOAA Schiano-NOAA changed the base branch from dev-1.1 to dev January 17, 2025 19:16
Schiano-NOAA and others added 8 commits January 17, 2025 14:16
* Minor grammatical changes just to set up new dev-1.1 branch (changed quarto --> Quarto)

* Feat(vignettes):
-added tables of contents to vignettes
-added tip for how to edit rda files to a11y vignette
-added link to faqs vignette to a11y vignette re: how to edit alt text and captions

---------

Co-authored-by: sbreitbart-NOAA <[email protected]>
* fix incorrect reference

* add url to reference fix
* update(create_template): comment out skeleton pop up at the end

* update(add_section): add functionality for putting new subsection into section

* Update(add_section): fix pathing for locating section to place code and change from add_chunk to add_child

* update(create_template): select only custom_sections when user wants to make a different outline of report

custom must = TRUE otherwise copies all files

* Fix(create_template): adjust if statement argument for custom_sections

* Add nmfspalette package back in

* removed add_theme and associated test and documentation

* remove static NOAA Fishies in authorship

* update NOAA fisheries affiliations

Co-authored-by: Schiano-NOAA <[email protected]>

---------

Co-authored-by: sbreitbart-NOAA <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Schiano-NOAA <[email protected]>
sbreitbart-NOAA and others added 17 commits January 21, 2025 15:49
-Fix so that rda files can be added as input, if already created, OR generated if model results are included as an argument.
-Update documentation
…ociated files and changes to create_template (#152)
-Started writing script in utils.R to merge and clean all datasets
-Started writing script in utils.R to merge and clean all datasets
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.

4 participants