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

Release for v0.3 #82

Draft
wants to merge 93 commits into
base: main
Choose a base branch
from
Draft

Release for v0.3 #82

wants to merge 93 commits into from

Conversation

Schiano-NOAA
Copy link
Collaborator

What is the feature?

*Major changes to push new release for v0.3 of asar

sbreitbart-NOAA and others added 30 commits October 16, 2024 16:54
Note: The text previously referenced an argument that was missing from the function ('title'). In my update, I changed it to 'sec_names'. Please verify that this was an accurate assumption.
…cripts (add_section, create_title, format_quarto) used same parameters (but with different names), changed the parameter names in associated scripts to names in create_template, then inherited parameter names from create_template to reduce redundancy.

Questions for Sam:
Please check/edit the "parameters" parameter's definition. What does it mean, and how should it be defined? Is it ever false?

Please check/edit the "param_values" parameter's definition. What does it mean, and how should it be defined?

Please check/edit the "convert_output" parameter's definition for accuracy.
Integration of the other captions once written and alt. text will form adjustments to here
* update(template): add changes for debugging and issue

- Added options for english and removed the old czech lang the in-header doc
- changed the chunks for figs and tabs not to render while development is occurring

* update(template): add changes for debugging and issue

- Added options for english and removed the old czech lang the in-header doc
- changed the chunks for figs and tabs not to render while development is occurring

* Attempt to inherit custom_sections parameter from asar::create_template()

* Changed remaining x's (former argument) into custom_sections (new argument), and removed the parameter definition

* Clarified argument definitions for create_title.R

* Clarified argument definitions in create_template. Since associated scripts (add_section, create_title, format_quarto) used same parameters (but with different names), changed the parameter names in associated scripts to names in create_template, then inherited parameter names from create_template to reduce redundancy.

Questions for Sam:
Please check/edit the "parameters" parameter's definition. What does it mean, and how should it be defined? Is it ever false?

Please check/edit the "param_values" parameter's definition. What does it mean, and how should it be defined?

Please check/edit the "convert_output" parameter's definition for accuracy.

* Clarified argument definitions in convert_output.R and updated documentation.

* update(create_figures_doc): add example of where caption will go

Integration of the other captions once written and alt. text will form adjustments to here

* refactor: Changed names of sections in create_template to those voted on by steering committee (as of Sept 2024)

* deleted files with outdated names (i.e., without numbers before descriptions

* updated test-create_template.R to avoid merge conflict

* Remove test folder pushed to repo

* fix(custom section op): change base_section, add_section, and test

- changes in both naming of arguments and templates were fixed
- test-add_section was adjusted so expected values were correct

* fix(assessment spelling): change file name and will now pass test

* delete(assessment_gloassaries.tex)

* fix(test-add_section): spelling error in test

* deleted files with outdated names (i.e., without numbers before descriptions

* updated test-create_template.R to avoid merge conflict

* Remove test folder pushed to repo

* fix(assessment spelling): change file name and will now pass test

* fix(test-add_section): change file names in test and adjust fxns to meet test expectations

* fix(test-create_template): add to resdir to remove warning in test

* delete(utils): remove add_base_section from utils

* Attempt to inherit custom_sections parameter from asar::create_template()

* Changed remaining x's (former argument) into custom_sections (new argument), and removed the parameter definition

* Clarified argument definitions for add_child.R

* Clarified argument definitions for add_chunk.R

* Clarified argument definitions for add_section.R.

Note: The text previously referenced an argument that was missing from the function ('title'). In my update, I changed it to 'sec_names'. Please verify that this was an accurate assumption.

* Clarified argument definitions for create_citation.R

* Clarified argument definitions for create_figures_doc.R

* Clarified argument definitions for create_title.R

* Clarified argument definitions for export_object.R

* Clarified argument definitions for format_quarto.R

* Clarified argument definitions in create_template. Since associated scripts (add_section, create_title, format_quarto) used same parameters (but with different names), changed the parameter names in associated scripts to names in create_template, then inherited parameter names from create_template to reduce redundancy.

Questions for Sam:
Please check/edit the "parameters" parameter's definition. What does it mean, and how should it be defined? Is it ever false?

Please check/edit the "param_values" parameter's definition. What does it mean, and how should it be defined?

Please check/edit the "convert_output" parameter's definition for accuracy.

* Updated documentation

* Clarified argument definitions in convert_output.R and updated documentation.

* Update(affiliation_info.csv): add country

* update(create_figures_doc): add example of where caption will go

Integration of the other captions once written and alt. text will form adjustments to here

* Attempt to inherit custom_sections parameter from asar::create_template()

* Changed remaining x's (former argument) into custom_sections (new argument), and removed the parameter definition

* Clarified argument definitions for create_title.R

* Clarified argument definitions in create_template. Since associated scripts (add_section, create_title, format_quarto) used same parameters (but with different names), changed the parameter names in associated scripts to names in create_template, then inherited parameter names from create_template to reduce redundancy.

Questions for Sam:
Please check/edit the "parameters" parameter's definition. What does it mean, and how should it be defined? Is it ever false?

Please check/edit the "param_values" parameter's definition. What does it mean, and how should it be defined?

Please check/edit the "convert_output" parameter's definition for accuracy.

* Clarified argument definitions in convert_output.R and updated documentation.

* refactor: Changed names of sections in create_template to those voted on by steering committee (as of Sept 2024)

* deleted files with outdated names (i.e., without numbers before descriptions

* updated test-create_template.R to avoid merge conflict

* Remove test folder pushed to repo

* fix(custom section op): change base_section, add_section, and test

- changes in both naming of arguments and templates were fixed
- test-add_section was adjusted so expected values were correct

* fix(assessment spelling): change file name and will now pass test

* delete(assessment_gloassaries.tex)

* fix(test-add_section): spelling error in test

* deleted files with outdated names (i.e., without numbers before descriptions

* updated test-create_template.R to avoid merge conflict

* Remove test folder pushed to repo

* fix(assessment spelling): change file name and will now pass test

* fix(test-add_section): change file names in test and adjust fxns to meet test expectations

* fix(test-create_template): add to resdir to remove warning in test

* delete(utils): remove add_base_section from utils

* Fix naming in create_template

---------

Co-authored-by: Schiano-NOAA <samantha.schiano@noaa.gov>
… have been included in the ss3/BAM model variable name guide/key and updating some variable definitions (#61)
…s and convert_output to pass tests

test-add_chunk commented out due to issues I can not find
Changing to a working example in read me that mimic that of a current stock assessment. The files resulting from the example and rendered report need to be added as their own example in a folder
# Summary

- add raw and converted petrale output to data folder
- ran usethis::use_data() creating structure for the example
- updated documentation
- read in converted output in chunk
- create place for pre-loaded quantities to reference later in the document
Might need to move folders - pushing now in order to switch branches ok
Schiano-NOAA and others added 30 commits October 25, 2024 16:43
Pkgdown vignettes

Thanks for resolving the failing test issues, @Schiano-NOAA !
… WORDLIST that R didn't recognize and added language to the DESCRIPTION file
Add accessibility article into site and add in references.bib file
Works with site
…underscore and paste spp name together with underscore
build: added alt text to cover page's US Dept of Commerce seal
* feature(find BAM fleet names)

Fix standard naming conventions sheet

* fix(convert_output):change age to numeric for converting purposes

* Update(documentation): fleet names documentation

Update create_template to reflect changes to convert_output

* Update(convert_output): fleet names not kept in D.release/Dosed.release

* Deprecate fleet_names parameter in create_template

* Update documentation for PR

* Fix(create_template): species naming in converted output within create_template

* fix(convert_output): add nsim factor

Nsim factor in BAM for eq.series and pr.series - might need further adjustment for naming (unsure if nsim)

* fix(convert_output test): reflect the new factor added to the output file

* fix(convert_output): aging error matrix for BAM incorrectly transformed

Reflect the changes and addition of another factor into the test
Shorten create_template chunk labels
fix: updated syntax for cover USDC logo
…for user, and added prompts to help the user expand upon prewritten alt text)
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