Skip to content

Commit

Permalink
more manuscript organization
Browse files Browse the repository at this point in the history
  • Loading branch information
nsheff committed Jun 13, 2024
1 parent a98c3fc commit 4ad732a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
11 changes: 8 additions & 3 deletions docs/geniml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,14 @@ As of Feburary 2024, this package and its documentation are undergoing rapid dev
pip install --user --upgrade geniml
```

## Modules and resources by publication
## Modules and resources

`geniml` is organized into modules. The modules section gives an [overview of each module](modules.md). `geniml` includes many genomic interval analysis methods published in a variety of separate publications. If you're coming here from a manuscript, you can also find the relevant tutorials by visiting the landing page for the publication of interest:
### Organization

`geniml` is organized into modules. The modules section gives an [overview of each module](modules.md).

### Browsing by publication

If you're coming here from a manuscript, you might find it easier to identify the tutorials relevant for a particular manuscript by visiting the landing page for the publication of interest. You can find documentation organized by manuscript in the [manuscripts section](../citations.md).

- [Rymuza et al. 2024](manuscripts/rymuza2024.md)

2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ nav:
- Changelog: geniml/changelog.md
- Gtars:
- Gtars: gtars/README.md
- How to cite:
- Manuscripts:
- How to cite: citations.md
- Published manuscripts:
- Gharavi et al. 2021: manuscripts/gharavi2021.md
Expand Down

0 comments on commit 4ad732a

Please sign in to comment.