Skip to content

Latest commit

 

History

History
192 lines (138 loc) · 5.8 KB

risk_exposure_template.rst

File metadata and controls

192 lines (138 loc) · 5.8 KB
Raw

Risk Exposure Model Template

Important

To begin documenting a risk exposure in GBD 2019 for a Vivarium simulation, start by following these steps (after you have :ref:`created a new git branch <contributing>` to work in):

  1. Make a subdirectory :file:`{risk_exposure_name}/` in the folder :file:`gbd2019/risks/` , where :file:`{risk_exposure_name}` is replaced with the (potentially shortened) name of the risk exposure you are modeling, such as :file:`unsafe_water_source/` or :file:`low_birthweight_short_gestation/`. This subdirectory is where you will put all the files for your exposure model documentation, including this document, image files, .csv files, etc.

  2. Copy this template into your subdirectory and rename it index.rst.

  3. Replace the internal hyperlink target .. _2019_risk_exposure_template: at the top of this file with a unique reference label for your cause. The reference label should have the form :samp:`.. _2019_risk_exposure_{\{risk_exposure_name\}}:`, where :samp:`{\{risk_exposure_name\}}` is replaced with a unique descriptive name or abbreviation for your risk exposure, e.g. .. _2019_risk_exposure_unsafe_water:.

  4. Delete this document's title above:

    ----------------------
Risk Exposure Template
----------------------

    Once the above title is deleted, all the other section titles will be promoted up one level.

  5. The subtitle below should now be the document's title. Replace the text in the below (sub)title with the full name of your risk exposure in GBD 2019. For example, if you were modeling the exposure "Low Birth Weight and Short Gestation," then the title

    ======================================
Full Name of Risk Exposure in GBD 2019
======================================

    should be replaced by

    ====================================
Low Birth Weight and Short Gestation
====================================

    Note: Be sure to adjust the length of the title's underline ====== and overline ====== to match the length of your new document title, or you will get errors in the section structure when Sphinx builds HTML from the :file:`index.rst` file.

  6. Once you complete these steps, delete this .. important:: directive from :file:`index.rst`.

Full Name of Risk Exposure in GBD 2019

Risk Exposure Overview

Include here a clinical background and overview of the risk exposure you're modeling. Note that this is only for the exposure; you will include information on the relative risk of the relevant outcomes, and the cause models for those outcomes, in a different document.

Risk Exposures Description in GBD

Include a description of this risk exposure model in the context of GBD, involving but not limited to:

  • What type of statistical model? (categorical, continuous?)

  • If a continuous model, the type of distribution (example: normal distribution) as well as distribution parameters (most often mean and standard deviation) must be specified.

  • How is the exposure estimated? (DisMod, STGPR?)
  • Which outcomes are affected by this risk?
  • TMREL? (This should be a very high level overview. Namely, does the TMREL vary by outcome? The details of the TMREL will be included in the Risk Outcome Relationship Model section)

Vivarium Modeling Strategy

Include here an overview of the Vivarium modeling section

Restrictions

GBD 2019 Risk Exposure Restrictions
Restriction Type Value Notes
Male only    
Female only    
Age group start    
Age group end     
..      todo::

        Determine if there's something analogous to "YLL/YLD only" for this section

Assumptions and Limitations

Describe the clinical and mathematical assumptions made for this cause model, and the limitations these assumptions impose on the applicability of the model.

Risk Exposure Model Diagram

Include diagram of Vivarium risk exposure model.

Data Description Tables

As of 02/10/2020: follow the template created by Ali for Iron Deficiency, copied below. If we discover it's not general enough to accommodate all exposure types, we need to revise the format in coworking.

Constants
Constant Value Note
     
Distribution Parameters
Parameter Value Note
     

Validation Criteria

..      todo::
        Fill in directives for this section

References