Skip to content

Commit

Permalink
Bumping up minor version for new feature
Browse files Browse the repository at this point in the history
  • Loading branch information
skchronicles committed Jun 5, 2024
1 parent 85b5f74 commit c20b602
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 12 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.0
0.2.0
12 changes: 6 additions & 6 deletions docker/mpox-seek/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ docker image ls

# Build from Dockerfile
ln -f ../../workflow/envs/mpox.yaml .
docker build --no-cache -f Dockerfile --tag=mpox-seek:v0.1.0 .
docker build --no-cache -f Dockerfile --tag=mpox-seek:v0.2.0 .

# Testing, take a peek inside
docker run -ti mpox-seek:v0.1.0 /bin/bash
docker run -ti mpox-seek:v0.2.0 /bin/bash

# Updating Tag before pushing to DockerHub
docker tag mpox-seek:v0.1.0 skchronicles/mpox-seek:v0.1.0
docker tag mpox-seek:v0.1.0 skchronicles/mpox-seek # latest
docker tag mpox-seek:v0.2.0 skchronicles/mpox-seek:v0.2.0
docker tag mpox-seek:v0.2.0 skchronicles/mpox-seek # latest

# Check out new tag(s)
docker image ls

# Push new tagged image to DockerHub
docker push skchronicles/mpox-seek:v0.1.0
docker push skchronicles/mpox-seek:v0.2.0
docker push skchronicles/mpox-seek:latest
```

Expand All @@ -30,7 +30,7 @@ docker push skchronicles/mpox-seek:latest
Scan your image for known vulnerabilities:

```bash
docker scan mpox-seek:v0.1.0
docker scan mpox-seek:v0.2.0
```

> **Please Note**: Any references to `skchronicles` should be replaced your username if you would also like to push the image to a non-org account.
10 changes: 10 additions & 0 deletions docs/usage/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,16 @@ Each of the following arguments are optional, and do not need to be provided.
>
> ***Example:*** `--bootstrap-trees`
---
`--plot-coverage`
> **Plots coverage of each sample.**
> *type: boolean flag*
> *default: false*
>
> This option will plot coverage along the reference genome. If this flag is provided, per-sample plots of raw coverage will be created. This plot can be useful for identifying samples or regions of the reference genome with low coverage. By default, the pipeline will not create any coverage plots.
>
> ***Example:*** `--plot-coverage`
### 2.3 Orchestration options

Each of the following arguments are optional, and do not need to be provided.
Expand Down
8 changes: 3 additions & 5 deletions mpox-seek
Original file line number Diff line number Diff line change
Expand Up @@ -473,11 +473,9 @@ def parsed_arguments(name, description):
--plot-coverage
Plots coverage of along the reference genome. If this flag
is provided, per-sample plots of raw and library normalized
coverage will be created. This plot can be useful for ident-
ifying samples or regions of the reference genome with low
coverage. The library normalized coverage track is useful
for comparing coverage across samples.
is provided, per-sample plots of raw coverage will be made.
This plot can be useful for identifying samples or regions
of the reference genome with low coverage.
Example: --plot-coverage
{3}{4}Orchestration options:{5}
Expand Down

0 comments on commit c20b602

Please sign in to comment.