Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
merszym committed Sep 26, 2024
1 parent cdf5e57 commit 3bda2a8
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## Unpublished
## [v2.2] - 2024-09-26

### Changes

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ http://ftp.eva.mpg.de/neandertal/Hohlenstein-Stadel/BAM/mtDNA/HST.raw_data.ALL.b
quicksand is executed directly from github, no local build is required. With the databases and the testdata downloaded, run the pipeline.

```bash
nextflow run mpieva/quicksand -r v2.1 \
nextflow run mpieva/quicksand -r v2.2 \
--db refseq/kraken/Mito_db_kmer22/ \
--genomes refseq/genomes/ \
--bedfiles refseq/masked/ \
Expand Down
2 changes: 1 addition & 1 deletion assets/pipeline/help.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Usage: nextflow run mpieva/quicksand -r v2.1 {--bam PATH --rg PATH | --split DIR} --db PATH --genome PATH --bedfiles PATH [options] -profile singularity
Usage: nextflow run mpieva/quicksand -r v2.2 {--bam PATH --rg PATH | --split DIR} --db PATH --genome PATH --bedfiles PATH [options] -profile singularity

required arguments:
Either:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
author = 'Merlin Szymanski'

# The full version, including alpha/beta/rc tags
release = 'v2.1'
version = 'v2.1'
release = 'v2.2'
version = 'v2.2'

# -- General configuration ---------------------------------------------------

Expand Down
12 changes: 6 additions & 6 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ families and the number of ancient sequences found.

Execute quicksand like this::

nextflow run mpieva/quicksand -r v2.1 \
nextflow run mpieva/quicksand -r v2.2 \
-profile singularity \
--split split/ \
--db refseq/kraken/Mito_db_kmer22/ \
Expand All @@ -29,7 +29,7 @@ The output files are grouped by family-level in the :code:`out/` directory. Extr
after the KrakenUniq run are stored in :code:`out/{family}/1-extracted/` while mapped, deduped and filtered sequences are saved to the
:code:`out/{family}/best/{step}/` directory after the respective processing step::

quicksand_v2.1
quicksand_v2.2
├── out
│ └── {family}
│ ├── 1-extracted
Expand Down Expand Up @@ -65,7 +65,7 @@ file-names and should be unique!::

and start the execution with::

nextflow run mpieva/quicksand -r v2.1 \
nextflow run mpieva/quicksand -r v2.2 \
-profile singularity \
--split split/ \
--db refseq/kraken/Mito_db_kmer22/ \
Expand All @@ -77,7 +77,7 @@ The output file structure remains the same as before. For families specified in
appear in the :code:`out/{family}/fixed/{step}/` directory, together with additional output-files
that are useful in additional downstream-analyses, such as the extracted deaminated reads::

quicksand_v2.1
quicksand_v2.2
├── out
│ └── {family}
│ ├── 1-extracted
Expand Down Expand Up @@ -122,14 +122,14 @@ After collecting the reference genome(s) for the Suidae family, prepare a fresh

and rerun the pipeline with::

nextflow run mpieva/quicksand -r v2.1 \
nextflow run mpieva/quicksand -r v2.2 \
-profile singularity \
--rerun \
--fixed fixed-references.tsv

The (additional) output files are the ones created by the :code:`--fixed` flag::

quicksand_v2.1
quicksand_v2.2
├── out
│ └── {family}
│ ├── 1-extracted
Expand Down
4 changes: 2 additions & 2 deletions docs/source/in_and_out.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ as readgroups::
Output
------

quicksand writes all output files to the **quicksand_v2.1** directory. Within this directory the files are
quicksand writes all output files to the **quicksand_v2.2** directory. Within this directory the files are
layed out as follows::

quicksand_v2.1
quicksand_v2.2
├── out
│ └── {taxon}
│ ├── 1-extracted
Expand Down
4 changes: 2 additions & 2 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ Run quicksand

nextflow pipelines can be executed directly from github. To run quicksand using the downloaded data-set type::

nextflow run mpieva/quicksand -r v2.1 \
nextflow run mpieva/quicksand -r v2.2 \
-profile singularity \
--db refseq/kraken/Mito_db_kmer22 \
--genomes refseq/genomes/ \
--bedfiles refseq/masked/ \
--split split/


| The output of quicksand can be found in the directory **quicksand_v2.1/**
| The output of quicksand can be found in the directory **quicksand_v2.2/**
| See the :code:`final_report.tsv` and :code:`filtered_report_0.5p_0.5b.tsv` for a summary of the results.
| See the :ref:`output-page` section for a detailed explaination of all the output files.
Expand Down
2 changes: 1 addition & 1 deletion nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ manifest {
homePage = 'https://mpieva.github.io/quicksand/'
description = 'quick analysis of sedimentary ancient DNA'
nextflowVersion = '>=22.10'
version = 'v2.1'
version = 'v2.2'
}

cleanup = true
Expand Down

0 comments on commit 3bda2a8

Please sign in to comment.