Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/data/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Example data

The models that the pages of the [user guide](../guide/index.md) load are copied here and not read from the `RAVEN` submodule, so that every snippet can use a short, stable path (`smallYeast.yml`) that works the same way for a reader who downloads the file and for the example runner in CI.
The models that the pages of the [user guide](../guide/index.md) load are copied here and are not read from the `RAVEN` submodule. Every snippet can therefore use a short path (`smallYeast.yml`), which works the same way for a reader who downloads the file and for the example runner in CI.

| File | Size | Source | Used by |
|---|---|---|---|
| [`smallYeast.yml`](smallYeast.yml) | 45 kB | `RAVEN/tutorials/data/models/smallYeast.yml` | the default example model for most guide pages |
| [`empty.xml`](empty.xml) | 4 kB | `RAVEN/tutorials/data/empty.xml` | [Building a model from scratch](../guide/building.md): an empty SBML model with compartments defined, to build a model from scratch |
| [`smallYeast.yml`](smallYeast.yml) | 45 kB | `RAVEN/tutorials/data/models/smallYeast.yml` | the default example model of most guide pages |
| [`empty.xml`](empty.xml) | 4 kB | `RAVEN/tutorials/data/empty.xml` | [Building a model from scratch](../guide/building.md): an empty SBML model with compartments, the start of a model built from scratch |
| [`smallYeastBad.yml`](smallYeastBad.yml) | 45 kB | `RAVEN/tutorials/data/models/smallYeastBad.yml` | [Quality control](../guide/quality-control.md) and [Comparing models](../guide/comparing.md), which need a model with known errors |
| [`yeast-GEM.yml`](yeast-GEM.yml) | 3.6 MB | yeast-GEM v9.1.0, `model/yeast-GEM.yml` | pages that need a genome-scale model: [Reading and writing models](../guide/io.md), [Simulating growth with FBA](../guide/fba.md), [Growth media and conditions](../guide/media.md), [Biomass composition and annotation](../guide/biomass.md) |
| [`yeast-GEM.yml`](yeast-GEM.yml) | 3.6 MB | yeast-GEM v9.1.0, `model/yeast-GEM.yml` | the pages that need a genome-scale model: [Reading and writing models](../guide/io.md), [Simulating growth with FBA](../guide/fba.md), [Growth media and conditions](../guide/media.md) and [Biomass composition and annotation](../guide/biomass.md) |
| [`yeast-GEM.xml`](yeast-GEM.xml) | 11.6 MB | yeast-GEM v9.1.0, `model/yeast-GEM.xml` | the same model as SBML, for [Reading and writing models](../guide/io.md) |
| [`anaerobic.yml`](anaerobic.yml) | 2 kB | transcribed from yeast-GEM's `anaerobicModel.m` | [Growth media and conditions](../guide/media.md): a condition file, yeast-GEM under anaerobic conditions |
| [`anaerobic.yml`](anaerobic.yml) | 2 kB | transcribed from `anaerobicModel.m` of yeast-GEM | [Growth media and conditions](../guide/media.md): a condition file, yeast-GEM under anaerobic conditions |
| [`tasks.txt`](tasks.txt) | 0.5 kB | written for this guide | [Metabolic tasks](../guide/tasks.md) and [Gap-filling](../guide/gap-filling.md): a task list for `smallYeast.yml` |
| [`curation-mets.tsv`](curation-mets.tsv) | 0.3 kB | written for this guide | [Table-driven curation](../guide/curation.md): a metabolite curation table |
| [`hpa-sample.tsv`](hpa-sample.tsv) | 1 kB | a ten-row excerpt in Human Protein Atlas format | [Context-specific models with ftINIT](../guide/init.md) |
| [`hpa-sample.tsv`](hpa-sample.tsv) | 1 kB | an excerpt of ten rows in Human Protein Atlas format | [Context-specific models with ftINIT](../guide/init.md) |

The two small yeast models are part of the RAVEN Toolbox (MIT licence). yeast-GEM is the consensus genome-scale model of *Saccharomyces cerevisiae* ([SysBioChalmers/yeast-GEM](https://github.com/SysBioChalmers/yeast-GEM), CC-BY-4.0). It is pinned here at release v9.1.0, so the numbers printed in the guide stay reproducible while the model keeps developing.
The two small yeast models are part of the RAVEN Toolbox (MIT licence). yeast-GEM is the consensus genome-scale model of *Saccharomyces cerevisiae* ([SysBioChalmers/yeast-GEM](https://github.com/SysBioChalmers/yeast-GEM), CC-BY-4.0). It is pinned at release v9.1.0, so the numbers printed in the guide stay reproducible while the model develops.

The `.yml` files are RAVEN YAML, read by `readYAMLmodel` in MATLAB and `read_yaml_model` in Python. `yeast-GEM.xml` is SBML, read by `importModel` and cobrapy's `read_sbml_model`.
The `.yml` files are RAVEN YAML, read by `readYAMLmodel` in MATLAB and `read_yaml_model` in Python. `yeast-GEM.xml` is SBML, read by `importModel` and by `read_sbml_model` of cobrapy.

## Refreshing the copies

The two RAVEN tutorial copies are deliberate duplicates and do not follow the `RAVEN` submodule automatically. After a submodule bump that changes either model, refresh the copies and re-run the examples:
The two RAVEN tutorial copies are deliberate duplicates and do not follow the `RAVEN` submodule automatically. After a submodule bump that changes either model, the copies are refreshed and the examples are run again:

```bash
cp "RAVEN/tutorials/data/models/smallYeast.yml" docs/data/smallYeast.yml
Expand All @@ -29,7 +29,7 @@ cp "RAVEN/tutorials/data/models/smallYeastBad.yml" docs/data/smallYeastBad.yml
python scripts/run_examples.py
```

A change of the pinned tag is a deliberate act, and it changes every number that the guide prints from the model. Bump the tag, re-download both files and re-generate the affected output blocks in one commit:
A change of the pinned tag is deliberate, and it changes every number that the guide prints from the model. The tag is bumped, both files are downloaded again, and the affected output blocks are regenerated in one commit:

```bash
YEAST_GEM=v9.1.0 # the release the guide currently documents
Expand All @@ -38,20 +38,20 @@ curl -sSL -o docs/data/yeast-GEM.xml "https://raw.githubusercontent.com/SysBioCh
python scripts/run_examples.py --update
```

Do not edit the files in place. Any change here makes the guide's numbers unreproducible, without a warning, for a reader who takes the model from RAVEN.
The files are never edited in place, and a change is made upstream and copied again. Any change here makes the numbers of the guide unreproducible without a warning for a reader who takes the model from RAVEN.

## Proteomes for homology reconstruction

`hanpo.faa` and `sce-template.faa` back [Reconstruction from homology](../guide/homology.md).
`hanpo.faa` and `sce-template.faa` serve [Reconstruction from homology](../guide/homology.md).

| file | what it is |
| File | Content |
|---|---|
| [`hanpo.faa`](hanpo.faa) | the *Hansenula polymorpha* proteome, 5177 sequences, copied unchanged from the `hanpo-GEM` submodule (`data/genomes/hanpo.faa`) |
| [`sce-template.faa`](sce-template.faa) | 61 *S. cerevisiae* sequences (exactly the genes of `smallYeast.yml`) extracted from the same submodule's `data/genomes/sce.faa` |
| [`hanpo.faa`](hanpo.faa) | the *Hansenula polymorpha* proteome with 5177 sequences, copied unchanged from the `hanpo-GEM` submodule (`data/genomes/hanpo.faa`) |
| [`sce-template.faa`](sce-template.faa) | 61 *S. cerevisiae* sequences (the genes of `smallYeast.yml`), extracted from `data/genomes/sce.faa` of the same submodule |

The template proteome is restricted to the genes of the model. BLAST against 61 subjects keeps the example of the homology page to about fifteen seconds per language, and a template protein that no reaction uses cannot contribute to the draft.
The template proteome is restricted to the genes of the model. A BLAST against 61 subjects keeps the example of the homology page at about fifteen seconds per language, and a template protein that no reaction uses cannot contribute to the draft.

Regenerate `sce-template.faa` after a change to `smallYeast.yml`:
`sce-template.faa` is regenerated after a change to `smallYeast.yml`:

```bash
python - <<'EOF'
Expand Down
Loading
Loading