Skip to main content

Lowest Common Ancestor on SAM/BAM/CRAM alignment files

Project description

DOI DOI badge

sam2lca

Lowest Common Ancestor from a SAM/BAM/CRAM sequence alignment file.

TLDR

Analysis of sequencing reads aligned to a DNA database with NCBI accession numbers, using the NCBI taxonomy

sam2lca analyze myfile.bam

See all options

sam2lca --help
sam2lca update-db --help
sam2lca list-db --help
sam2lca analyze --help

For further infos, check out the sam2lca documentation and tutorial

Installation

With Conda (recommended)

conda install -c bioconda sam2lca

With pip

pip install sam2lca

For development purposes, from the dev branch

# clone repository 
git clone git@github.com:maxibor/sam2lca.git
# work on the dev branch
git checkout dev
# work in the sam2lca conda environment
conda env create -f environment.yml
conda activate sam2lca
# install sam2lca in editable mode
pip install -e .
# Run the unit and integration tests
pytest -s -vv --script-launch-mode=subprocess

or

pip install git+ssh://git@github.com/maxibor/sam2lca.git@dev

Documentation

The documentation of sam2lca, including tutorials, is available here: sam2lca.readthedocs.io

Cite

sam2lca has been published in JOSS with the following DOI: 10.21105/joss.04360

@article{Borry2022,
  doi = {10.21105/joss.04360},
  url = {https://doi.org/10.21105/joss.04360},
  year = {2022},
  publisher = {The Open Journal},
  volume = {7},
  number = {74},
  pages = {4360},
  author = {Maxime Borry and Alexander Hübner and Christina Warinner},
  title = {sam2lca: Lowest Common Ancestor for SAM/BAM/CRAM alignment files},
  journal = {Journal of Open Source Software}
}

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

sam2lca-1.1.4.tar.gz (28.3 kB view hashes)

Uploaded Source

Built Distribution

sam2lca-1.1.4-py3-none-any.whl (31.1 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