docs: add methodology and workflow documentation#4
docs: add methodology and workflow documentation#4divine7022 wants to merge 3 commits intoccmmf:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds four Quarto documentation files for the SIPNET sensitivity analysis framework, covering theoretical methodology, pipeline workflow, package management, and references. These files integrate with the project's Quarto-based GitHub Pages site under the Docs section.
Changes:
- Added theoretical documentation for OAT and Sobol sensitivity analysis methods
- Added pipeline architecture and script reference documentation
- Added renv package management setup guide and references page
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docs/methodology.qmd |
Theoretical foundations for sensitivity analysis and variance decomposition |
docs/workflow_documentation.qmd |
Pipeline architecture, script execution order, and function library reference |
docs/renv_setup.qmd |
renv setup, SCC-specific notes, and troubleshooting guide |
docs/references.qmd |
Cited references for methods used in the framework |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Saltelli Sampling Scheme | ||
|
|
||
| We use Saltelli's sampling design with Jansen estimators, which requires $N(2k + 2)$ model evaluations for $k$ parameters, providing efficient estimation of both $S_i$ and $T_i$. |
There was a problem hiding this comment.
The stated formula workflow_documentation.qmd line 120, which correctly states
| We use Saltelli's sampling design with Jansen estimators, which requires $N(2k + 2)$ model evaluations for $k$ parameters, providing efficient estimation of both $S_i$ and $T_i$. | |
| We use Saltelli's sampling design with Jansen estimators, which requires $N(k + 2)$ model evaluations for $k$ parameters, providing efficient estimation of both $S_i$ and $T_i$. |
|
|
||
| Dietze, M. C. (2017). Ecological Forecasting. Princeton University Press. | ||
|
|
||
| Saltelli, A., et al. (2010). Variance based sensitivity analysis. Computer Physics Communications. |
There was a problem hiding this comment.
The full title of the Saltelli et al. (2010) paper is "Variance based sensitivity analysis of model output. Design and estimator for the total sensitivity index". The truncated title "Variance based sensitivity analysis" is incomplete and could be confused with other works. Consider providing the complete title for accuracy.
| Saltelli, A., et al. (2010). Variance based sensitivity analysis. Computer Physics Communications. | |
| Saltelli, A., et al. (2010). Variance based sensitivity analysis of model output. Design and estimator for the total sensitivity index. Computer Physics Communications. |
|
|
||
| # Overview | ||
|
|
||
| This document describes the theoretical foundations and methodological approaches used in the SIPNET sensitivity analysis workflow. The framework follows established best practices in ecological forecasting (Dietze 2017) and variance-based sensitivity analysis (Saltelli et al. 2008). |
There was a problem hiding this comment.
The in-text citation references "Saltelli et al. 2008," but the references page (references.qmd) only lists a 2010 Saltelli et al. publication. Either the citation year should be updated to 2010 to match the listed reference, or the 2008 reference (Saltelli, A., et al. (2008). Global Sensitivity Analysis: The Primer. Wiley) should be added to references.qmd.
| This document describes the theoretical foundations and methodological approaches used in the SIPNET sensitivity analysis workflow. The framework follows established best practices in ecological forecasting (Dietze 2017) and variance-based sensitivity analysis (Saltelli et al. 2008). | |
| This document describes the theoretical foundations and methodological approaches used in the SIPNET sensitivity analysis workflow. The framework follows established best practices in ecological forecasting (Dietze 2017) and variance-based sensitivity analysis (Saltelli et al. 2010). |
Adds documentation for the sensitivity analysis framework:
These integrate with the quarto github pages under the Docs section.