Skip to content

Commit

Permalink
add round 2 abstract
Browse files Browse the repository at this point in the history
  • Loading branch information
LucieContamin committed Nov 14, 2024
1 parent 332294e commit 7c3bc7a
Show file tree
Hide file tree
Showing 3 changed files with 176 additions and 0 deletions.
68 changes: 68 additions & 0 deletions model-abstract/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Model Abstract

This folder contains abstract files per round for team-models submitting to the
Scenario Modeling Hub.

----

## Subdirectory

Each sub-directory within the [model-abstract/](./) directory has the
format:

team-model

where

- `team` is the abbraviated teamname (`team_abbr`) and
- `model` is the abbreviated name of your model (`model_abbr`).

Both team and model should be less than 15 characters, and not include
hyphens nor spaces.

The `team-model` should correspond to the `team-model` sub-directory in the
associated model-output folder containing the associated projections.

----

## Template

Each abstract is associated with a specific round. A template of
the expected abstract format is available in the
[template/](./template/) folder.


## Abstract file

Each abstract file within the subdirectory should have the following
name

YYYY-MM-DD-team-model.md

where

- `YYYY` is the 4 digit year,
- `MM` is the 2 digit month,
- `DD` is the 2 digit day,
- `team` is the teamname, and
- `model` is the name of your model.

The date YYYY-MM-DD should correspond to the start date for scenarios
projection ("first date of simulated transmission/outcomes" as noted in the
scenario description on the main
[README, Submission Information](https://github.com/midas-network/rsv-scenario-modeling-hub)).

Please keep the sections (or headings), lines starting with `#`, as
they are in the templates and only change spaces marked with `FILL`.
All markdown associated format is accepted, except the addition of other
sections (or headings).

For more information on the markdown format, please consult the
[GitHub - Basic writing and formatting syntax help page](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)

### Examples

The [model-abstract/](./) contains an example abstract file from
a `team2-modelb` team. The abstract file associated with the example
is a copy of a template file, the example here is mainly design
to illustrate the organization of the folder and the file naming system.
54 changes: 54 additions & 0 deletions model-abstract/team2-modelb/2024-07-28-team2-modelb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## Summary of Results
FILL

## General Model Description
FILL

## Explanation of observed dynamics given model assumptions
FILL

## Model Calibration

### General calibration approach
FILL

### Was the model calibrated to 2023-24 data, and if so how? And how was the counterfactual scenario generated?
FILL

## Model Assumptions

### **Immunity assumptions** (describe protection against infection and severe disease, duration of immunity and waning distributions)

#### Immunity after natural infection
FILL

#### Maternal immunity
FILL

#### Immunity from maternal vaccines
FILL

#### Immunity from nirsevimab
FILL

#### Immunity from senior vaccines
FILL

### **Seasonality implementation**
FILL

### **Initial Conditions**
FILL

### **Age groups considered** (especially within under 1 yo, and whether within season aging is considered)
FILL

### **Geography**

#### State-stratification details (prior immunity, seasonality, severity/reporting)
FILL

#### Process to generate national projections (separate model fitted to US data vs aggregation of projection from RSVnet states)
FILL

### **Other Model Assumptions**
54 changes: 54 additions & 0 deletions model-abstract/template/2024-07-28.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## Summary of Results
FILL

## General Model Description
FILL

## Explanation of observed dynamics given model assumptions
FILL

## Model Calibration

### General calibration approach
FILL

### Was the model calibrated to 2023-24 data, and if so how? And how was the counterfactual scenario generated?
FILL

## Model Assumptions

### **Immunity assumptions** (describe protection against infection and severe disease, duration of immunity and waning distributions)

#### Immunity after natural infection
FILL

#### Maternal immunity
FILL

#### Immunity from maternal vaccines
FILL

#### Immunity from nirsevimab
FILL

#### Immunity from senior vaccines
FILL

### **Seasonality implementation**
FILL

### **Initial Conditions**
FILL

### **Age groups considered** (especially within under 1 yo, and whether within season aging is considered)
FILL

### **Geography**

#### State-stratification details (prior immunity, seasonality, severity/reporting)
FILL

#### Process to generate national projections (separate model fitted to US data vs aggregation of projection from RSVnet states)
FILL

### **Other Model Assumptions**

0 comments on commit 7c3bc7a

Please sign in to comment.