sra-downloader
A script for batch-downloading and automatic compression of data from NCBI Sequence Read Archive. Built on SRA-Toolkit.
Features:
- Downloading SRAs using either accession IDs or NCBI generated files
- Organizing sequences by projects that they come from
- Detecting which runs have been already downloaded
Requirements
- python >= 3.6
- sra-toolkit >= 2.9.6
- pigz
Instalation
0. Docker
- Run
docker run wwydmanski/sra-downloader -h
1. Conda (recommended, also downloads sra-toolkit)
- Run
conda install -c bioconda -c bioinf-mcb sra-downloader
Note: if you don't specify the bioconda channel you will get a dependency error.
2. From PyPi
- Run
pip install sra-downloader
3. From sources
- Download a repo into a folder
- Run
pip install .
Usage
usage: sra-downloader [-h] [--fname FILENAME] [--save-dir SAVE_DIRECTORY] [--uncompressed [UNCOMPRESSED]] [--cores [CORES]] [sra_id [sra_id ...]]
Download SRA data and organize them by projects
positional arguments:
sra_id SRA IDs to download
optional arguments:
-h, --help show this help message and exit
--fname FILENAME CSV file with list of SRAs to download. Header must include `Run` and `BioProject`.
--save-dir SAVE_DIRECTORY
a directory that the files will be saved to. (default: ./downloaded)
--uncompressed [UNCOMPRESSED]
if present, the files will not be compressed. (default: False)
--cores [CORES] Cores used for compression. (default is the number of online processors, or 8 if unknown)
Examples
sra-downloader ERR2177760 --uncompressed
docker run -v $(pwd)/downloads:/downloaded wwydmanski/sra-downloader ERR1551967
sra-downloader --fname SraRunTable.txt --save-dir ./SRAs --cores 4
Sample output
└─── save_folder
├── PRJEB14961
│ ├── ERR1551967.sra_1.fastq.gz # - raw read archived files from SRA
│ ├── ERR1551967.sra_2.fastq.gz
│ └── SraRunTable.txt # - original SraRunTable.txt with useful metadata about samples
└── PRJEB20463
├── ERR2177760.sra_1.fastq.gz
├── ERR2177760.sra_2.fastq.gz
├── absent.txt # - entries that were unaccessible due to various reasons
└── SraRunTable.txt
Metadata
Release files for sra-downloader 1.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sra-downloader-1.0.7.tar.gz | 5.0 kB | Without provenance | Details for sra-downloader-1.0.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sra_downloader-1.0.7-py3-none-any.whl | Python 3 | none | any | Details for sra_downloader-1.0.7-py3-none-any.whl |
Total release size: 11.7 kB
Release files / sra-downloader-1.0.7.tar.gz
| Download URL | sra-downloader-1.0.7.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d1b94ebfc4cd7b55d8ba15c149aa055b0050b36b3d2c0a301e67ab4563f6806b
|
|
BLAKE2b-256 checksum How to use checksums |
60cc3b87418232fdb614aab55b265708bc117a0fa3985356b4c154282352f093
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.5
|
Release files / sra_downloader-1.0.7-py3-none-any.whl
| Download URL | sra_downloader-1.0.7-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
04cbf8a472b4ec6d1cd84a633ea1fea158dcca540e1445d6115a4cd932a1e990
|
|
BLAKE2b-256 checksum How to use checksums |
114e98494ca0554eea20c219fe853029f148382c1fa01aee22e715cd6d857f11
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.5
|
Security for sra-downloader 1.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.