nmfs-ost / asar

Partially automate a U.S. stock assessment report.
https://nmfs-ost.github.io/asar/
MIT License
15 stars 3 forks source link

Review definitions for function parameteres #52

Closed Schiano-NOAA closed 1 month ago

Schiano-NOAA commented 1 month ago

@kellijohnson-NOAA identified that some descriptions following parameters in the create_template.R function are not sufficient for the user to understand what they are doing. This might be the case for other functions as well in the code. For example, in create_template, the argument parameters and similar arguments are defined as:

https://github.com/nmfs-ost/asar/blob/0be022bb70733835ab60909a00651248d79f0b9c/R/create_template.R#L20-L24

Functions for review:

Schiano-NOAA commented 1 month ago

@sbreitbart-NOAA could you tackle some of these? I would start with add_base_section, add_child, add_chunk, add_section, create_citation. I will begin to review create_template and convert_output, but will request your review for an additional set of eyes afterwards.

Please perform these actions in the dev branch that is opened or a branch from the dev branch that you can later merge into the dev branch. The idea is that I plan to create a new beta release with better documentation, a new working example, and other bug fixes.