MethodologyTemplate.md 2.56 KB
Newer Older
Aaron Bray's avatar
Aaron Bray committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
%Methodology Template {#MethodologyTemplate}
==========================

Overview
========

Abstract
--------

Brief summary of what.

In general, write the abstract as one sentence from each major section.
So, one intro, one methods, one validation/results, and one conclusions.

Introduction
------------

More details about why and how.

System Design
=============

Background and Scope
--------------------

Include where the models originated and why we chose them.

### Requirements

### Existing

### Approach

Data Flow
---------

### Initialize

Initialize, setup, tune, conditions, stabilization, etc.

### Preprocess

### Process

### Post Process

### Assessments

Features and Capabilities
-------------------------

Include a discussion about model fidelity.

### Definitions

Table with symbols (if needed).

### Circuit

Include a circuit diagram.

### Patient Variability

How changes in the patient affect the model.

### Feedback

How the homeostatic methodology works.

### Dependencies

How does this system interact with other systems?

### Outputs

Any discussion about system outputs?

Assumptions and Limitations
---------------------------

Conditions
----------

Actions
-------

### Insults

### Interventions

Events
------

Include irreversible states.

Assessments
-----------

Results and Conclusions
=======================

%Verification
-------------

Often through unit tests.

Validation - Resting Physiologic State
--------------------------------------

Use the auto-generated table.

Explain the good and the bad, note why the bad is either being addressed
or okay.

Validation - Conditions
-----------------------

Include validation tables.

Validation - Actions
--------------------

Include validation tables and plots.

Validation - Assessments
------------------------

Conclusions
-----------

1-2 sentences for each of the following: sum up what we have done, have
we advanced the state of the art (hint: yes), note the worst and how it
is being addressed or why it is ok, note the best stuff, why is this is
good step, who will find this useful

Future Work
===========

Coming Soon
-----------

142
What else is in the works.
Aaron Bray's avatar
Aaron Bray committed
143 144 145

Improvements to existing methodology planned. Include
a why statement. Need to know why this improvement is a good thing to
146
do, what is gained.
Aaron Bray's avatar
Aaron Bray committed
147 148 149 150

Recommended Improvements
------------------------

151
What should be updated and why.
Aaron Bray's avatar
Aaron Bray committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

Appendices
==========

Acronyms
--------

Define terms and acronyms.

Data Model Implementation
-------------------------

Link to associated classes.

Compartments
------------

Include a tree showing the compartments.