Skip to content

Commit

Permalink
docs: Add NBIAToolkit CLI usage to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jjjermiah committed Feb 1, 2024
1 parent 22ccb4c commit 4cd3785
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,34 @@ pip install nbiatoolkit
### getCollections
nbia-toolkit also provides a command line interface (CLI) to query the NBIA database for some queries.
``` bash
> getCollections --prefix NSCLC
NSCLC Radiogenomics
NSCLC-Radiomics
NSCLC-Radiomics-Genomics
NSCLC-Radiomics-Interobserver1

> getCollections --prefix TCGA | head -5
TCGA-BLCA
TCGA-BRCA
TCGA-CESC
TCGA-COAD
TCGA-ESCA
❯ NBIAToolkit
_ ______ _______ ______ ____ _ __
/ | / / __ )/ _/ |/_ __/___ ____ / / /__(_) /_
/ |/ / __ |/ // /| | / / / __ \/ __ \/ / //_/ / __/
/ /| / /_/ // // ___ |/ / / /_/ / /_/ / / ,< / / /_
/_/ |_/_____/___/_/ |_/_/ \____/\____/_/_/|_/_/\__/


Version: 0.14.0

Available CLI tools:

getCollections [-h] [-p PREFIX] [-o OUTPUTFILE] [--version]

getPatients [-h] -c COLLECTION [-o OUTPUTFILE] [--version]

getBodyPartCounts [-h] [-c COLLECTION] [-o OUTPUTFILE] [--version]

getSeries [-h] [-c COLLECTION] [-p PATIENTID] [-m MODALITY]
[-study STUDYINSTANCEUID]
[--seriesInstanceUID SERIESINSTANCEUID]
[--bodyPartExamined BODYPARTEXAMINED]
[--manufacturerModelName MANUFACTURERMODELNAME]
[--manufacturer MANUFACTURER] [-o OUTPUTFILE] [--version]

downloadSingleSeries [-h] --seriesUID SERIESUID --downloadDir
DOWNLOADDIR [--filePattern FILEPATTERN]
[--overwrite]
```


Expand Down

0 comments on commit 4cd3785

Please sign in to comment.