docs: add README
This commit is contained in:
parent
0ebb84a8d1
commit
e0b4037a59
17
README.md
Normal file
17
README.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# TCGA Downloader
|
||||||
|
|
||||||
|
Python package + CLI to query public TCGA files and download via gdc-client.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```bash
|
||||||
|
tcga-downloader query --project TCGA-BRCA --data-type "Gene Expression" --out manifest.tsv
|
||||||
|
|
||||||
|
tcga-downloader download --manifest manifest.tsv --out-dir ./data
|
||||||
|
```
|
||||||
5
tests/test_readme.py
Normal file
5
tests/test_readme.py
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
def test_readme_present():
|
||||||
|
assert Path("README.md").exists()
|
||||||
Loading…
Reference in New Issue
Block a user