Skip to content

Commit

Permalink
add params to yaml bump to v2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
rpetit3 committed Aug 25, 2024
1 parent 3725e3a commit 9d48a59
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/*.tsv
camlhmp-blast-thresholds/
4 changes: 2 additions & 2 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
image: nfcore/gitpod:latest
image: condaforge/miniforge3:24.3.0-0

tasks:
- name: Initialize
init: |
pip install graphviz
. /opt/conda/etc/profile.d/conda.sh
conda activate base
mamba create -n pasty-dev -y -q -c conda-forge -c bioconda camlhmp
conda create -n pasty-dev -y -q -c conda-forge -c bioconda camlhmp
conda activate pasty-dev
git checkout main
vscode:
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Releases

## v2.2.0 rpetit3/pasty "JBPA" - 2024/08/25

- add default parameters for `--min-pident` and `--min-coverage` in the YAML

## v2.1.0 rpetit3/pasty "LESB58" - 2024/08/19

- add serogroups O15 and O17 https://github.com/rpetit3/pasty/pull/5 @StefaanVerwimp
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ pasty --help
│ [required] │
│ --outdir -o PATH Directory to write output [default: ./] │
│ --prefix -p TEXT Prefix to use for output files [default: camlhmp] │
│ --min-pident INTEGER Minimum percent identity to count a hit [default: 95] │
│ --min-coverage INTEGER Minimum percent coverage to count a hit [default: 95] │
│ --min-pident INTEGER Minimum percent identity to count a hit [default: 80] │
│ --min-coverage INTEGER Minimum percent coverage to count a hit [default: 80] │
│ --force Overwrite existing reports │
│ --verbose Increase the verbosity of output │
│ --silent Only critical errors will be printed │
Expand Down Expand Up @@ -84,11 +84,15 @@ The directory to save result files. If the directory does not exist is will be c

### --min-pident

__*Note: This should be automatically set for you!*__

The minimum percent identity for a blast hit to be considered for serogrouping. The is compared
against the `pident` column of the blast output.

### --min-coverage

__*Note: This should be automatically set for you!*__

The minimum coverage of a O-antigen to be considered for serogrouping. This looks at the percent
of the O-antigen that was aligned to. This calculation does include mismatches and gaps,
but those should be expected to be minimal if `--min_pident` is set to the default (95%) or
Expand Down
5 changes: 4 additions & 1 deletion data/pa-osa.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@ metadata:
id: "pasty" # id of the schema
name: "P. aeruginosa serogrouping" # name of the schema
description: "Serogrouping of Pseudomonas aeruginosa isolates" # description of the schema
version: "2.1.0" # version of the schema
version: "2.2.0" # version of the schema
curators: # A list of curators of the schema
- "Robert A. Petit III"

# engine provides information about the tool and parameters used
engine:
type: blast # The type of tool used to generate the data
tool: blastn # The tool used to generate the data
params:
min_pident: 80 # The minimum percent identity for a hit to be considered
min_coverage: 80 # The minimum query coverage for a hit to be considered

# targets provides a list of sequence targets (primers, genes, proteins, etc...)
targets:
Expand Down

0 comments on commit 9d48a59

Please sign in to comment.