databio / bedboss

Python pipeline for processing BED files for BEDbase
https://docs.bedbase.org
BSD 2-Clause "Simplified" License
1 stars 0 forks source link

bedboss

[![PEP compatible](https://pepkit.github.io/img/PEP-compatible-green.svg)](https://pep.databio.org/) ![Run pytests](https://github.com/bedbase/bedboss/workflows/Run%20instalation%20test/badge.svg) [![pypi-badge](https://img.shields.io/pypi/v/bedboss?color=%2334D058)](https://pypi.org/project/bedboss) [![pypi-version](https://img.shields.io/pypi/pyversions/bedboss.svg?color=%2334D058)](https://pypi.org/project/bedboss) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Github badge](https://img.shields.io/badge/source-github-354a75?logo=github)](https://github.com/databio/bedboss)

Documentation: https://docs.bedbase.org/bedboss

Source Code: https://github.com/databio/bedboss


BEDboss is a command-line management tool for BEDbase. It contains pipelines that filters, standardizes, and calculates statistics for genomic interval data, functions that enters the results into a BEDbase database, deletes bed and bedsets from the database, and indexes the data to qdrant.

Installation

To install bedboss use this command:

pip install bedboss

or install the latest version from the GitHub repository:

pip install git+https://github.com/databio/bedboss.git

Development

For development, you should install all the dependencies, create a virtual environment, and work on the local database. The workflow is described in the development documentation.

Testing

Requirements test:

To test requirements, install bedboss and run:

bedboss requirements-check

Smoke tests:

Use this docs:

How to generate usage documentation:

Run this command in the root of the repository:

cd scripts
bash update_usage_docs.sh