Skip to content

Commit

Permalink
🚧 add seqkit as external dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
victorlin committed Aug 27, 2024
1 parent 57a9ca8 commit c099e16
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
- name: Install dependencies from Conda
uses: mamba-org/setup-micromamba@v1
with:
create-args: mafft raxml fasttree iqtree vcftools sqlite tsv-utils biopython=${{ matrix.biopython-version }} python=${{ matrix.python-version }}
create-args: mafft raxml fasttree iqtree vcftools seqkit sqlite tsv-utils biopython=${{ matrix.biopython-version }} python=${{ matrix.python-version }}
condarc: |
channels:
- conda-forge
Expand Down
4 changes: 4 additions & 0 deletions augur/merge.py
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,10 @@ def cat(filepath: str):


def merge_sequences(args):
# Confirm that seqkit is installed.
if which("seqkit") is None:
raise AugurError("'seqkit' is not installed! This is required to merge sequences.")

# Parse --sequences arguments
if not len(args.sequences) >= 2:
raise AugurError(f"At least two sequence inputs are required for merging.")
Expand Down
8 changes: 4 additions & 4 deletions docs/installation/non-python-dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Augur uses some external bioinformatics programs that are not available on PyPI:
- `RAxML <https://cme.h-its.org/exelixis/web/software/raxml/>`__ (optional alternative)
- `FastTree <http://www.microbesonline.org/fasttree/>`__ (optional alternative)

- ``augur merge`` requires ``sqlite3``, the `SQLite <https://sqlite.org>`__ CLI (version ≥3.39).
- ``augur merge`` requires ``sqlite3`` (the `SQLite <https://sqlite.org>`__ CLI (version ≥3.39)) for metadata and ``seqkit`` for sequences.

- Bacterial data (or any VCF usage) requires `vcftools <https://vcftools.github.io/>`__

Expand All @@ -20,19 +20,19 @@ If you use Conda, you can install them in an active environment:

.. code:: bash
conda install -c conda-forge -c bioconda mafft raxml fasttree iqtree vcftools sqlite --yes
conda install -c conda-forge -c bioconda mafft raxml fasttree iqtree vcftools seqkit sqlite --yes
On macOS using `Homebrew <https://brew.sh/>`__:

.. code:: bash
brew tap brewsci/bio
brew install mafft iqtree raxml fasttree vcftools sqlite
brew install mafft iqtree raxml fasttree vcftools seqkit sqlite
On Debian/Ubuntu:

.. code:: bash
sudo apt install mafft iqtree raxml fasttree vcftools sqlite3
sudo apt install mafft iqtree raxml fasttree vcftools seqkit sqlite3
Other Linux distributions will likely have the same packages available, although the names may differ slightly.

0 comments on commit c099e16

Please sign in to comment.