From 9276e1fea11920eac4c69d119c1fb9fd728a2fe8 Mon Sep 17 00:00:00 2001 From: "Laura Luebbert, Ph.D." <56094636+lauraluebbert@users.noreply.github.com> Date: Sun, 13 Oct 2024 22:00:11 +0200 Subject: [PATCH] Improve readability of examples --- docs/src/en/ref.md | 45 +++++++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 20 deletions(-) diff --git a/docs/src/en/ref.md b/docs/src/en/ref.md index 5e8c90fd..889109dd 100644 --- a/docs/src/en/ref.md +++ b/docs/src/en/ref.md @@ -50,26 +50,6 @@ Python: Use `verbose=False` to prevent progress information from being displayed ### Examples -**Use `gget ref` in combination with [kallisto | bustools](https://www.kallistobus.tools/kb_usage/kb_ref/) to build a reference index:** -```bash -kb ref -i INDEX -g T2G -f1 FASTA $(gget ref --ftp -w dna,gtf homo_sapiens) -``` -→ kb ref builds a reference index using the latest DNA and GTF files of species **Homo sapiens** passed to it by `gget ref`. - -

- -**List all available genomes from Ensembl release 103:** -```bash -gget ref --list_species -r 103 -``` -```python -# Python -gget.ref(species=None, list_species=True, release=103) -``` -→ Returns a list with all available genomes (checks if GTF and FASTAs are available) from Ensembl release 103. -(If no release is specified, `gget ref` will always return information from the latest Ensembl release.) - -

**Get the genome reference for a specific species:** ```bash @@ -101,6 +81,31 @@ gget.ref("homo_sapiens", which=["gtf", "dna"]) } ``` +

+ +**List all available genomes from Ensembl release 103:** +```bash +gget ref --list_species -r 103 +``` +```python +# Python +gget.ref(species=None, list_species=True, release=103) +``` +→ Returns a list with all available genomes (checks if GTF and FASTAs are available) from Ensembl release 103. +(If no release is specified, `gget ref` will always return information from the latest Ensembl release.) + +

+ +**Use `gget ref` in combination with [kallisto | bustools](https://www.kallistobus.tools/kb_usage/kb_ref/) to build a reference index:** +```bash +kb ref \ + -i index.idx \ + -g t2g.txt \ + -f1 fasta.fa \ + $(gget ref --ftp -w dna,gtf homo_sapiens) +``` +→ kb ref builds a reference index using the latest DNA and GTF files of species **Homo sapiens** passed to it by `gget ref`. + #### [More examples](https://github.com/pachterlab/gget_examples) # References