-
Notifications
You must be signed in to change notification settings - Fork 11
[docs] create living guidelines as site articles #491
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
base: main
Are you sure you want to change the base?
Changes from all commits
170a06c
d4e0937
20d1ff8
b20384b
610a0b4
ea7b69c
81c01fd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,87 @@ | ||||||||||
| --- | ||||||||||
| title: "NMFS Stock Assessment Guidelines" | ||||||||||
| format: | ||||||||||
| html: | ||||||||||
| toc: true | ||||||||||
| toc-depth: 3 | ||||||||||
| anchor-sections: true | ||||||||||
| other-links: | ||||||||||
| - text: stockplotr | ||||||||||
| href: https://nmfs-ost.github.io/stockplotr/ | ||||||||||
| knitr: | ||||||||||
| opts_chunk: | ||||||||||
| collapse: true | ||||||||||
| comment: '#>' | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| ## General guidance | ||||||||||
|
|
||||||||||
| The following sections are a recommended outline for a U.S. fisheries stock assessment report. The goal is to effectively present information to managers to provide the best scientific advice available within a reasonable framework. This effort shifts the focus of assessment documents from being SSC and statistical review focus to more succinct review of information to aid in quicker decision making. {asar} is a tool that can generate a template that will meet the following guidelines. It contains standardized sections, figures, and tables for the user as well as formatting so the title page and authorship sections are not included here. Authors not using the template generated from {asar} should place tables and figures at the end of the document. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I took some info from the appendix section and moved it here because I think it's very important for explaining the essential attributes of the main report body vs. appendix. I'd recommend adding a link to the appendix section here too |
||||||||||
|
|
||||||||||
| Note: terms of reference are intended to remain as a stand alone document or can be included in an appendix at the end of the report. Direct answers to the terms of reference should not be included in the body of the stock assessment report. | ||||||||||
|
|
||||||||||
| ## Outline for Stock Assessment Reports | ||||||||||
|
|
||||||||||
| ### Executive Summary: | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| Where possible the executive summary should paraphrase the shared content of the body of the report to minimize redundancy. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What do you mean by "shared content"? |
||||||||||
|
|
||||||||||
| The executive summary should include the following: | ||||||||||
|
|
||||||||||
| * Short statement describing assessment model used for the current management cycle and any data updates. | ||||||||||
| * Short summary of reference points, stock status, and projections. In the future, when using the {asar} R package, tables of reference points and projections will be automatically generated. | ||||||||||
|
|
||||||||||
| ### Introduction: | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| The intent is to keep this section to two to three pages and provide a high level summary of the stock. The intention is to provide enough information in this section so the audience does not need to reference previous documents. Please include the species scientific name at the first mention of its common name. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| * Stock ID (detailed description if appropriate and quantitative studies or data are behind the decision-making) | ||||||||||
| * Management history: Briefly describe the management history of the stock and status. Please only touch on historical policies that would have impacted modeling decisions or would be critical knowledge about the species that might affect its population dynamics. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| * Assessment history | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| * Fishery Description: Short summary of fleet composition (i.e., boat types), gear types, species targeted, and fishing grounds (one paragraph) | ||||||||||
| * Ecosystem Considerations: If this section is not relevant, please ignore; however the default will state “Ecosystem considerations and/or climate indicators were not included in this assessment.” | ||||||||||
|
|
||||||||||
| ### Data: | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| Please provide relevant data that entered the assessment model including temporal and spatial resolutions, sample size, and units where appropriate for each of the following: | ||||||||||
|
|
||||||||||
| * Life History (growth, maturity, fecundity, natural mortality, meristics, etc.) | ||||||||||
| * Catch (retained and discarded) | ||||||||||
| * Indices and standardization (Fishery dependent and independent) | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| * Composition data - age, length (Description, aging error, reweighting) | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| * Absolute abundance (if applicable) | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| * Environmental/ecosystem indicator data. Please include a blanket statement if none are considered. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ### Assessment | ||||||||||
|
|
||||||||||
| Current modeling approach: short general overview of modeling platform including the reference to model paper or online reference. Please include a short description of changes between the approach from the last assessment cycle to the current. Please also note the version of the modelling platform used for this assessment. | ||||||||||
|
|
||||||||||
| * Configuration of the base model: please describe the setup of the stock assessment model. Please also include any environmental relationships/hypotheses that informed the configuration of the base model. | ||||||||||
| * Bridging: Briefly describe the bridging analysis performed to the previous assessment. | ||||||||||
| * Modeling Results: for each of the following please describe the results for the base model. | ||||||||||
| * Parameter Estimates | ||||||||||
| * Time Series | ||||||||||
| * Model Fits | ||||||||||
| * Model Diagnostics | ||||||||||
| * Sensitivity Analyses | ||||||||||
| * Management Benchmarks: decisions on management metrics/benchmarks (i.e. provide a rationale for why a specific F-proxy was recommended for management) | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you mean "e.g." (an example), as opposed to "i.e."? |
||||||||||
| * Projections: Description of stock status, biological reference points (BRPs), and trends for each scenario; rebuilding times | ||||||||||
|
|
||||||||||
| ### Discussion: | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| Dependent on analyst/assessment/region; please include sub sections discussing ecosystem considerations (if applicable) and research recommendations/improvements to the assessment | ||||||||||
|
|
||||||||||
| * Research Recommendations | ||||||||||
|
|
||||||||||
| ### References | ||||||||||
|
|
||||||||||
| ### Tables: | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| At minimum, please include the following tables into the report (when applicable to the stock). Pre-made figures can be found in the {stockplotr} package downloaded from GitHub. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Which tables? |
||||||||||
|
|
||||||||||
| ### Figures: | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Which figures? |
||||||||||
| At minimum, please include the following figures into the report (when applicable to the stock). Pre-made figures can be found in the {stockplotr} package downloaded from GitHub. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ### Appendices: Any information relevant for evaluation of the stock either during SSC or management review should be included in the appendix. The main assessment document should contain the minimum necessary information to inform and provide management advice for the stock while additional materials can be found in the appendix. It is not intended for the appendices to be a catch-all. We highly encourage authors to review the need and irreplaceable value of the report's content when it comes to addressing the audience. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you mean to write "either during SSC or management review"? I think you mean "either during SSC or statistical review"? |
||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor change to match the menu item name