[docs]: Create README files for all folders#499
Open
sbreitbart-NOAA wants to merge 2 commits into
Open
Conversation
… add spaces next to bullets in pull request template to facilitate automatic formatting
Contributor
Checklist
|
Contributor
New version checklist
|
2 tasks
Contributor
Code Metrics Report
Reported by octocov |
|
|
||
| # What is the feature? | ||
| * | ||
| * |
Collaborator
There was a problem hiding this comment.
Suggested change
| * | |
| * |
Collaborator
There was a problem hiding this comment.
Just removing the space bc its not neccessary
|
|
||
| # How have you implemented the solution? | ||
| * | ||
| * |
Collaborator
There was a problem hiding this comment.
Suggested change
| * | |
| * |
|
|
||
| # Does the PR impact any other area of the project, maybe another repo? | ||
| * | ||
| * |
Collaborator
There was a problem hiding this comment.
Suggested change
| * | |
| * |
| @@ -0,0 +1,8 @@ | |||
| # GitHub Workflows and Templates | |||
|
|
|||
| This folder contains the workflows to initiate: | |||
Collaborator
There was a problem hiding this comment.
I would add more information about the workflow. This is a folder housing GitHub workflows that perform actions such as X. I think it could be helpful for future us and maintainers to described how some of these were made (e.g. ghactions4r)
Collaborator
There was a problem hiding this comment.
Why was this file deleted?
Schiano-NOAA
requested changes
Jun 24, 2026
Schiano-NOAA
left a comment
Schiano-NOAA
left a comment
Collaborator
There was a problem hiding this comment.
This looks great! An awesome thing for future us, contributors, and long term maintenance for the package. I have a few questions and minor concerns with some suggestions. Let me know what you think! Once they are resolved, it should be good to go.
Collaborator
There was a problem hiding this comment.
Why was this file deleted?
|
|
||
| This folder contains various files which support the creation of materials for running functions in {asar}. | ||
|
|
||
| * WORDLIST contains a list of words that are used in the spell check workflow. It is a plain text file with one word per line. The words in this list are considered correct and will not be flagged as spelling errors during the spell check process. |
Collaborator
There was a problem hiding this comment.
Suggested change
| * WORDLIST contains a list of words that are used in the spell check workflow. It is a plain text file with one word per line. The words in this list are considered correct and will not be flagged as spelling errors during the spell check process. | |
| * WORDLIST contains a list of words that are used in the spell check workflow. It is a plain text file with one word per line. The words in this list are considered correct and will not be flagged as spelling errors during the spell check process. Words can be added or removed from this list by running `spelling::update_wordlist()`. |
|
|
||
| ## Sub-folders | ||
|
|
||
| * The `extdata` sub-folder contains an example of an SS3 report file that can be input into `convert_output()`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| * The `extdata` sub-folder contains an example of an SS3 report file that can be input into `convert_output()`. | |
| * The `extdata` sub-folder contains an example of an SS3 report file that can be input into `stockplotr::convert_output()`. |
| @@ -0,0 +1,7 @@ | |||
| # Functions | |||
|
|
|||
| This folder is composed of all the exported and utility functions used in {asar}. These utility functions are typically used to perform intermediary tasks in the process of making a report, and are run within the other functions. | |||
Collaborator
There was a problem hiding this comment.
Suggested change
| This folder is composed of all the exported and utility functions used in {asar}. These utility functions are typically used to perform intermediary tasks in the process of making a report, and are run within the other functions. | |
| This folder is composed of all the exported and utility functions (utils) used in {asar}. These utility functions are typically used to perform intermediary tasks in the process of making a report, and are run within the other functions. |
|
|
||
| In this function, the users have the option to convert output files to a standardized | ||
| framework from either SS3 (Report.sso) or BAM (.rdat) output files. `asar` uses this | ||
| framework from either SS3 (Report.sso), BAM (.rdat), FIMS, or Rceattle output files. `asar` uses this |
Collaborator
There was a problem hiding this comment.
Suggested change
| framework from either SS3 (Report.sso), BAM (.rdat), FIMS, or Rceattle output files. `asar` uses this | |
| framework from either SS3 (Report.sso), BAM (.rdat), FIMS (R object), or Rceattle (R object) output files. `asar` uses this |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Create README files for folders in the repo per #481