Skip to content

databio/bedboss

Folders and files

NameName
Last commit message
Last commit date
Jan 6, 2025
Jan 17, 2025
Jan 16, 2025
Nov 27, 2023
Nov 27, 2023
Jan 16, 2025
Dec 19, 2024
Jan 13, 2025
Sep 11, 2024
Sep 6, 2024
Feb 1, 2023
Jan 16, 2025
Apr 8, 2024
Aug 26, 2024

Repository files navigation

bedboss

PEP compatible Run pytests pypi-badge pypi-version Code style: black Github badge


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