GEO Collector
Description
GEOcollector is a Python package for collecting metadata about gene expression datasets from the NCBI Gene Expression Omnibus (GEO) database. It will convert a list of GSM accession numbers and cell types into the information required for FastqToGeneCounts to process the raw RNA-seq data.
Long story short, given an input file like this:
GSM,cell_type
GSM3785334,baso
GSM3898581,baso
GEOcollector will output a file like this (without formatted columns):
GSE ,GSM ,SRR ,Rename ,Strand ,Prep Method ,Platform Code ,Platform Name ,Source ,Cell Characteristics ,Replicate Name ,Strategy ,Publication ,Extra Notes
GSE131525 ,GSM3785334 ,SRR9097791 ,baso_S1R1 ,SE ,total ,GPL16791 ,Illumina HiSeq 2500 (Homo sapiens) ,B ,subject - disease status: Screened Healthy Control;subject: HC3;age at draw: 55;Sex: Female;median cv coverage: 0.763618;fastq total reads: 6241803;unpaired reads examined: 5663490;unpaired read duplicates: 1597507;primary race: White; ,lib3945 ,RNA-Seq ,31671072 ,
GSE133028 ,GSM3898581 ,SRR9328889 ,baso_S2R1 ,PE ,total ,GPL20301 ,Illumina HiSeq 4000 (Homo sapiens) ,peripheral blood ,cell type: peripheral blood B cells; ,Patient 2 IgD-CD27- double negative B cells from the peripheral blood ,RNA-Seq ,32859762 ,
GSE133028 ,GSM3898591 ,SRR9328899 ,baso_S2R2 ,PE ,total ,GPL20301 ,Illumina HiSeq 4000 (Homo sapiens) ,peripheral blood ,cell type: peripheral blood B cells; ,Patient 3 IgD-CD27- double negative B cells from the peripheral blood ,RNA-Seq ,32859762 ,
Installation
To install GEOcollector, you can use pip:
pip install GEOcollector
Usage
The following sections are command line parameters associated with GEOcollector
Command Line Interface
To execute GEOcollector, simply call it from the command line with the relevant parameters
geocollector --api-key APIKEY --input-file /home/user/input.csv --verbose
geocollector --input-file /home/user/input.csv --quiet
geocollector --api-key APIKEY --input-file /home/user/input.csv
To view help for GEOcollector, run the following command
geocollector --help
API Key
Without an API key, NCBI limits the number of requests to 3 per second. With an API key, this value is increased to 10 requests per second. To obtain an API key, follow the below steps
- Access NCBI's website
- Click "Log In" in the top right corner
- If you do not have an account, create one now
- Click your username in the top right corner
- Click "Account settings" in the dropdown menu
- Scroll down to the "API Key" section
- Click "Create API Key"
- Copy the API key that has been created
Input file
The input file should be a CSV file in the following format. Multiple GSMs can be associated to a single cell type
GSM,cell_type
GSM_1,cell_type_1
GSM_2,cell_type_1
GSM_3,cell_type_1
GSM_4,cell_type_2
Verbosity
If you would like to show debug information on the command line, pass the flag --verbose. If you would like to silence
all output (except warnings), pass the flag --quiet. If neither flag is passed, standard "info" messages will be shown
If you have problems, please create a new issue
Metadata
Release files for geocollector 1.1.3
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 |
|---|---|---|---|---|
| geocollector-1.1.3.tar.gz | 9.8 kB | Without provenance | Details for geocollector-1.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| geocollector-1.1.3-py3-none-any.whl | Python 3 | none | any | Details for geocollector-1.1.3-py3-none-any.whl |
Total release size: 19.9 kB
Release files / geocollector-1.1.3.tar.gz
| Download URL | geocollector-1.1.3.tar.gz |
|---|---|
| Size | 9.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
354ff8ca456853f51238baa4724f9fdc03fb08107c68f3b593a842ec4d4e0269
|
|
BLAKE2b-256 checksum How to use checksums |
76f1b1d3e4e55675cf41a264454520d229a49aad856e9e33461db856242c1c67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.0 Linux/6.2.0-1012-azure
|
Release files / geocollector-1.1.3-py3-none-any.whl
| Download URL | geocollector-1.1.3-py3-none-any.whl |
|---|---|
| Size | 10.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b0596ee0c7007209deba9c5a0efc7f561e415c789984ba9c68e6e12aba413daf
|
|
BLAKE2b-256 checksum How to use checksums |
96eb5e8a4568adb8c37886b8de0643e7b8423641e832be5054f4fb1f299f8f5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.0 Linux/6.2.0-1012-azure
|
Security for geocollector 1.1.3
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.