Skip to content

Commit a1aa882

Browse files
committed
updates to the paper
1 parent ac8e149 commit a1aa882

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

docs/images/genescape-app.png

1.27 MB
Loading

docs/paper.bib

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,10 @@ @InProceedings{networkx
102102
editor = {Ga\"el Varoquaux and Travis Vaught and Jarrod Millman},
103103
}
104104

105+
@Manual{shiny,
106+
title = {shiny: Web Application Framework for R},
107+
author = {Winston Chang and Joe Cheng and JJ Allaire and Carson Sievert and Barret Schloerke and Yihui Xie and Jeff Allen and Jonathan McPherson and Alan Dipert and Barbara Borges},
108+
year = {2024},
109+
note = {R package version 1.8.1.9000, https://github.com/rstudio/shiny},
110+
url = {https://shiny.posit.co/},
111+
}

docs/paper.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,27 @@ The most annotated gene in the human genome, `HTT1`, currently has 1098 annotati
3939

4040
Web-based tools designed to visualize and filter gene ontology data include `AmiGO` [@AmiGO] and `QuickGO` [@QuickGO]. Command line tools like `goatools` [@goatools] support GO term lineage visualization. R packages like `topGO` [@topGO] implement GO structure visualizations of enriched GO terms. We are unaware of locally installable software that specifically allows for interactive filtering and visualization of gene ontology derived on gene lists.
4141

42-
GeneScape is a Python package that allows users to visualize a list of gene products in terms of the functional context represented by the Gene Ontology. GeneScape is distributed both as a command-line tool and as GUI-enabled standalone software via the [Shiny platform][shiny], thus making it accessible to a wide range of users.
42+
GeneScape is a Python package that allows users to visualize a list of gene products in terms of the functional context represented by the Gene Ontology.
43+
44+
GeneScape is distributed both as a command-line tool and as GUI-enabled standalone software via the [Shiny platform][shiny] [@shiny], thus making it accessible to a wide range of users.
45+
46+
![GeneScape as a Shiny App \label{fig:shiny}](images/genescape-app.png)
4347

4448
[shiny]: https://shiny.posit.co/
4549

46-
GeneScape is distributed with prebuilt databases for human and mouse genomes. For other organisms, users need to download the GAF files from the Gene Ontology website and run the command:
50+
GeneScape comes with a number of prebuilt databases for model organisms including the human, mouse, rat, fruitfly and zebrafish genomes. To study additional organisms, users must download GAF files from the Gene Ontology website and create custom databases using the `build` subcommand:
4751

4852
```
4953
genescape build --gaf mydata.gaf.gz --index mydata.index.gz
5054
```
5155

52-
The `build` command will create a database that can then be used for all subsequent analyses with the software. Users should consult the [GeneScape documentation][docs] for up-to-date details.
56+
For detailed instructions on using the software, users should refer to the [GeneScape documentation][docs]. A Q&A discussion board is also available on the GeneScape GitHub page.
5357

5458
[genescape]: https://github.com/ialbert/genescape-central
5559
[docs]: https://github.com/ialbert/genescape-central
5660

61+
## Typical usage
62+
5763
A typical usage starts with a gene list such as:
5864

5965
```
@@ -63,7 +69,13 @@ C3P1
6369
GRTP1
6470
```
6571

66-
GeneScape first transforms the above gene input list into a GO term list, where additional information is added to each term:
72+
Users can process the list above via the command line or via the Shiny interface. A command line invocation might look like:
73+
74+
```console
75+
genescape tree genes.txt -o output.pdf
76+
```
77+
78+
Internally, GeneScape first transforms the input gene list into a GO term list, where additional information is added to each term:
6779

6880
```
6981
count,function,root,goid,source,size,label

0 commit comments

Comments
 (0)