Skip to main content

No project description provided

Project description

PlasAnn

Plasmid annotation pipeline

This tool is designed for annotating plasmid sequences from FASTA or GenBank files. It utilizes various databases and tools to provide a comprehensive annotation of plasmid sequences, including the detection of coding sequences (CDS), origins of replication, transposons, and more.

Features

  • When the program is run for the first time the Databases will get downloaded automatically.
  • The pipeline can take single fasta file or a folder of fasta files as input.
  • It can also take a genbank file or a folder of genbank files as input

Installation

Dependencies

This script requires the following Python packages:

  • gdown
  • argparse
  • pandas
  • biopython
  • matplotlib
  • pycirclize

Additionally, it relies on external tools such as Prodigal. Ensure these dependencies are installed:

pip install gdown pandas biopython matplotlib

Installing Prodigal

You can download and install Prodigal from its official repository: from here

Installing command line blast

Command line blast needs to be installed. Follow the installation instruction here
Remember to append the path to the new BLAST bin directory to the existing PATH setting.

Usage

To run the script, go to the script folder and then use the following command:

python annotate_plasmids.py -i <input_file_or_directory> -o <output_directory> -t <file_type>

if you are running the script from other folder be sure to specify the path to annotate_plasmid.py. For example:

python /path_to_the_main_pipeline_folder/Scripts/annotate_plasmids.py -i <input_file_or_directory> -o <output_directory> -t <file_type>

Parameters

  • -i, --input: Path to the input file or directory containing FASTA or GenBank files.
  • -o, --output: Path to the output directory where results will be stored.
  • -t, --type: Type of the input files, either fasta or genbank.

Example Commands

For FASTA Files:

python annotate_plasmids.py -i /path/to/fasta/files -o /path/to/output/directory -t fasta

For GenBank Files:

python annotate_plasmids.py -i /path/to/genbank/files -o /path/to/output/directory -t genbank

Upon choosing GenBank as the file type, you will be prompted to select one of the following options:

  1. Annotate the existing CDS in the genbank file.
  2. Overwrite existing CDS in GenBank files using Prodigal.

Outputs

  • CSV Tables: Contain the annotation details for each plasmid.
  • GenBank Files: Annotated GenBank files with updated feature annotations.
  • Plasmid Maps: PNG images representing the annotated plasmid.

This tool is for large plasmids.

Regarding any issues Contact me

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

plasan-0.1.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

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

plasan-0.1-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file plasan-0.1.tar.gz.

File metadata

  • Download URL: plasan-0.1.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for plasan-0.1.tar.gz
Algorithm Hash digest
SHA256 97ae33b9fdb3a32a5df14c694b79e2bbcfd9e0fc4cdcd15f4c27f15445336dc8
MD5 0783fde81deb67ac6dc951ee7b364d84
BLAKE2b-256 047b52030a02cf0b840fe283a69b9d735fe20e27a55c8579fc80fc23f3744078

See more details on using hashes here.

File details

Details for the file plasan-0.1-py3-none-any.whl.

File metadata

  • Download URL: plasan-0.1-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for plasan-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 94f9e6912a3c48e4ead1c08226672fc7bb8a65ad61c826cd2d041d33e1ac4c72
MD5 a5f84db9625b5efe1995b2777b538c69
BLAKE2b-256 965ee6c8e6f7f8a16cdcc599346542b54457efb98c4811db29488bfb57e39580

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