Skip to main content

A simple library and CLI tool to manipulate BED files

Project description

Build Status Docs Status JOSS Status DOI License: MIT

Bedparse

Bedparse is a simple python module and CLI tool to perform common operations on BED files.

It offers 11 sub-commands that implement the following functionality:

  • filter: Filtering of transcripts based on annotations
  • join: Joining of annotation files based on transcript names
  • gtf2bed: Conversion from GTF to BED format
  • convertChr: Conversion from UCSC to Ensembl chromosome names (and viceversa)
  • bed12tobed6: Conversion from bed12 to bed6
  • promoter: Promoter reporting
  • introns: Intron reporting
  • cds: CDS reporting
  • 3pUTR and 5pUTR: UTR reporting
  • validateFormat: Check that the file conforms with the BED format

Installation

Installing is as simple as:

pip install bedparse

Basic usage

The basic syntax in the form: bedparse subcommand [parameters].

For a list of all subcommands and a brief explanation of what they do, use: bedparse --help.

For a detailed explanation of each subcommand and a list of its parameters, use the --help option after the subcommand's name, e.g.: bedparse promoter --help

Documentation

Our documentation is hosted on Read the Docs.

We also have a short tutorial to guide you through the basic functions.

Publications

If you use bedparse please cite the following paper:

Leonardi, (2019). Bedparse: feature extraction from BED files. Journal of Open Source Software, 4(34), 1228, https://doi.org/10.21105/joss.01228

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

bedparse-0.2.3.tar.gz (24.9 kB view hashes)

Uploaded Source

Built Distribution

bedparse-0.2.3-py3-none-any.whl (21.4 kB view hashes)

Uploaded Python 3

Supported by

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