Skip to main content

An easy and convenient way to import data from the sra database and creating OTU and Taxonomy tables.

Project description

SRA-Importer

An easy and convenient way to import data from the sra database and creating OTU and Taxonomy tables.

Requirements

The package's use requires:

  • qiime2 conda environment: The package must run from qiime2 conda environment. If one do not have a qiime2 conda environment installed, follow the instructions from here to install it.
  • SRA Toolkit: The package also depends on SRA Toolkit. If one do not have a SRA Toolkit installed, follow the instructions from here to install it. Importing is divided to 2 stages:

Create Visualization

The first stage is in charge of taking the data from the sra database and make a visualization of the reads. The visualization purpose is to make better assessment of the range in which one should trim and truncate the reads generated by qiime2.

Parameters

  • acc_list: Accession list file. This file must be stored locally.
  • output_vis_path: An output path for the visualisation. (Optional)

Return

The name of the directory created for all the files.

Usage

from SRA_Importer import visualization

output_dir = visualization(acc_list="AccList.txt", output_vis_path="vis.qzv")
print(output_dir) # .../SRA-Importer-[creation_time]

Note: This stage creates a directory. DO NOT DELETE IT! Its name is an input to the next stage.

In order to decide the trim and trunc values for the next stage, drag and drop the visualization output (.qzv) to QIIME2-VIEW

Export Data

The second stage is in charge of creating OTU and Taxonomy tables and export them into a usable file formats.

Parameters

  • output_dir: The path of the directory created by the first stage.
  • otu_output_file: An output path for the OTU table. The directory must exist, and the file's format must be txt/tsv.
  • taxonomy_output_file: An output path for the taxonomy table. The directory must exist, and the file's format must be tsv.
  • classifier_file: A path to the classifier file. If one needs to download it, it is recommended to download from https://data.qiime2.org/< qiime2-version >/common/gg-13-8-99-nb-classifier.qza

DADA2 parameters

  • trim: a non-negative integer of the right edge of the trimming range. If the reads are both forward and reverse a tuple of 2 values is expected.
  • trunc: a non-negative integer of the left edge of the truncating range. If the reads are both forward and reverse a tuple of 2 values is expected.
  • threads: Number of threads to run on. Default is 12. (Optional)

Note: All the parameters except threads must be given.

Usage

from SRA_Importer import export

export(output_dir="SRA-Importer...", trim=20, trunc=200, 
       classifier_file="gg-13-8-99-nb-classifier.qza", 
       otu_output_file="otu.txt", taxonomy_output_file="taxonomy.tsv")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

SRA-Importer-0.0.11.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

SRA_Importer-0.0.11-cp39-cp39-win_amd64.whl (7.7 kB view details)

Uploaded CPython 3.9Windows x86-64

File details

Details for the file SRA-Importer-0.0.11.tar.gz.

File metadata

  • Download URL: SRA-Importer-0.0.11.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.5

File hashes

Hashes for SRA-Importer-0.0.11.tar.gz
Algorithm Hash digest
SHA256 7b5c56f0605147bab9e2d3c845a804056dcad8e7216f63b0c3651861cb44fd3b
MD5 13f13e6c468416c733aac8d68a453b10
BLAKE2b-256 032767e8f8469f31fcaed2e6110c86e72699b838dd908c54e2935fd089f2e6fa

See more details on using hashes here.

File details

Details for the file SRA_Importer-0.0.11-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for SRA_Importer-0.0.11-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 cfab98e8dd8b96ce5a788ab1a9afe7c74bd3359db5b86eb867a5c03506bd21e3
MD5 bf2b4c48ac9eb2b0fb7380fbb947f610
BLAKE2b-256 07be7ea83238ae96c8831797eb969b119beac6fef1c495c34b21243e8933d2c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page