Skip to content

Commit c349083

Browse files
committed
Update documentation
1 parent 61d20f8 commit c349083

2 files changed

Lines changed: 46 additions & 6 deletions

File tree

app/sitemap.xml/route.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ export async function GET() {
6666

6767
const staticLastmod = overall ? `<lastmod>${overall}</lastmod>` : "";
6868
xml += ` <sitemap><loc>${SITE_URL}/sitemap/static.xml</loc>${staticLastmod}</sitemap>\n`;
69+
xml += ` <sitemap><loc>${SITE_URL}/cli/sitemap.xml</loc></sitemap>\n`;
6970

7071
for (const { key } of SITEMAP_SOURCES) {
7172
const chunks = Math.ceil((counts[key] ?? 0) / LIMIT);

public/llms.txt

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# seqout
22

33
> seqout is a search engine for public sequencing datasets.
4-
> It unifies metadata from NCBI GEO, SRA, ENA, DDBJ, and EBI ArrayExpress into a
5-
> single relevance-ranked search, with consolidated sample tables, cross-archive
6-
> cross-references, similarity graphs, download links, and SLM-enriched ontology
7-
> metadata (tissue, cell type, disease). Built at Saket Lab, IIT Bombay.
4+
> It unifies metadata from NCBI GEO, SRA, ENA, DDBJ (DRA and GEA), EBI ArrayExpress
5+
> and GSA into a single relevance-ranked search, with consolidated sample tables,
6+
> cross-archive cross-references, similarity graphs, download links, and SLM-enriched
7+
> ontology metadata (tissue, cell type, disease). Built at Saket Lab, IIT Bombay.
88

99
## Coverage
1010

1111
- ~1M projects / studies (GEO Series, SRA/ENA/DDBJ studies, ArrayExpress experiments)
1212
- Tens of millions of samples, experiments, and runs
13-
- Sources: NCBI GEO, NCBI SRA, EBI ENA, DDBJ, EBI ArrayExpress, BioProject
13+
- Sources: NCBI GEO, NCBI SRA, EBI ENA, DDBJ (DRA and GEA), EBI ArrayExpress, GSA, BioProject
1414
- Publication links with journal + citation counts
1515

1616
## Key pages
@@ -30,7 +30,46 @@
3030
Exposes search, project/sample metadata, download manifests, and enriched
3131
metadata as MCP tools.
3232

33+
## Python and R clients
34+
35+
Both search the same data, resolve an accession to its records in every archive, and
36+
read GEO supplementary files as counts matrices. Full details, including per-function
37+
documentation, are at https://seqout.org/cli/llms.txt
38+
39+
- Overview: https://seqout.org/cli/
40+
- Python library and `seqout` command line: https://seqout.org/cli/python/
41+
- R package: https://seqout.org/cli/R/
42+
- Source: https://github.com/saketlab/seqout
43+
44+
```bash
45+
uv add seqout # Python library, needs Python 3.13+
46+
uv add 'seqout[counts]' # with the counts-matrix readers
47+
uv tool install seqout # the seqout command line
48+
```
49+
50+
```r
51+
pak::pak("saketlab/seqout/R")
52+
install.packages("seqout", repos = "https://saketlab.r-universe.dev")
53+
```
54+
55+
```python
56+
from seqout import connect, seqout_counts
57+
58+
sq = connect()
59+
sq.search("liver cancer scRNA", organism="Homo sapiens")
60+
sq.get("GSE151530").samples
61+
seqout_counts(gse="GSE297547").matrix(sample="GSM8994520")
62+
```
63+
64+
```r
65+
library(seqout)
66+
67+
con <- seqout_connect()
68+
find_projects(con, keywords = "liver cancer scRNA", organism = "Homo sapiens")
69+
project_samples(con, "GSE151530")
70+
```
71+
3372
## Citation
3473

3574
seqout is developed and maintained by Saket Lab, IIT Bombay (https://saketlab.org).
36-
Source: https://github.com/saketlab/seqout-web
75+
Source: https://github.com/saketlab/seqout-web (web), https://github.com/saketlab/seqout (clients)

0 commit comments

Comments
 (0)