... | ... | @@ -7,6 +7,11 @@ Methodology Layout |
|
|
|
|
|
All reports have the same basic layout and information that follows the [Methodology Template] (https://gitlab.kitware.com/physiology/engine/blob/master/docs/Methodology/MethodologyTemplate.md). These documents need to be updated as part of the contribution process.
|
|
|
|
|
|
Adding Citations
|
|
|
----------------
|
|
|
|
|
|
???
|
|
|
|
|
|
Adding Images and Plots
|
|
|
-----------------------
|
|
|
|
... | ... | @@ -44,18 +49,22 @@ Adding Tables |
|
|
With a few exceptions, all system variables (i.e., vitals) should have a healthy standard validation value associated with it. These tables are in the *Validation - Resting Physiologic State* section of each system methodology document (see the respiratory report example [here] (https://pulse.kitware.com/_respiratory_methodology.html#respiratory-validation)). The tables are automatically generated from verification scenario outputs during the [Generating Documentation] (https://gitlab.kitware.com/physiology/engine/wikis/Generating%20Documentation) process.
|
|
|
|
|
|
Values can be added to the validation table by following these steps:
|
|
|
|
|
|
1. Add the new *DataRequest* to the appropriate pba scenario file in the `<pulse/build>/install/bin/verification/scenarios/validation` directory. You will need to [update the baselines] (https://gitlab.kitware.com/physiology/engine/wikis/Updating%20Baselines) as part of the submission process.
|
|
|
|
|
|
2. Add the associated properly cited validation data to a new row in the proper validation Excel spreadsheet located in the [validation directory] (https://gitlab.kitware.com/physiology/engine/tree/master/test/validation).
|
|
|
|
|
|
### Static Tables
|
|
|
|
|
|
Static tabular data can be added directly to the Markdown files using the [appropriate format] (https://help.github.com/articles/organizing-information-with-tables/).
|
|
|
|
|
|
### Scenario Validation Tables
|
|
|
|
|
|
Each action and condition should have at least one scenario associated with it and all scenarios should have expected values for important parameters to validate appropriate functionality.
|
|
|
Each action and condition should have at least one scenario associated with it and all scenarios should have expected values for important parameters to validate correct functionality. These tables are not automatically generated, so you will need to add them directly to the Markdown file by following these steps:
|
|
|
|
|
|
engine\test\validation
|
|
|
1. Add the table as a new tab in the appropriate validation excel spreadsheet located in the [scenarios validation directory] (https://gitlab.kitware.com/physiology/engine/tree/master/test/validation/Scenarios) directory. You will need to include any citations for where these validation values come from. See the examples to include cells with Markdown table formatting for easy copying and pasting into the Markdown file.
|
|
|
|
|
|
2. Copy and paste the table into the *Scenario Validation* section of the methodology document (see the respiratory example [here] (https://pulse.kitware.com/_respiratory_methodology.html#respiratory-actionvalidation).
|
|
|
|
|
|
Adding Equations
|
|
|
----------------
|
... | ... | |