Skip to content

Commit

Permalink
Merge pull request #95 from nf-core/post-release-bump
Browse files Browse the repository at this point in the history
Post-release bump
  • Loading branch information
scwatts committed Sep 9, 2024
2 parents 0648ad6 + c244ed0 commit bdcb87d
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 34 deletions.
25 changes: 0 additions & 25 deletions .bumpversion.cfg

This file was deleted.

4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project mostly adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [dev]

- [95](https://github.com/nf-core/oncoanalyser/pull/95) - Post-release bump

## [[1.0.0](https://github.com/nf-core/oncoanalyser/releases/tag/1.0.0)] Pied Currawong - 2024-08-26

Initial release of nf-core/oncoanalyser, created with the [nf-core](https://nf-co.re/) template.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Launch `oncoanalyser`:
```bash
nextflow run nf-core/oncoanalyser \
-profile docker \
-revision 1.0.0 \
-revision dev \
--mode wgts \
--genome GRCh38_hmf \
--input samplesheet.csv \
Expand Down
14 changes: 7 additions & 7 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ details and columns are [described below](#column-descriptions).

Several different input filetypes beyond FASTQ and BAM are recognised, including intermediate output files generated
during execution such as the PURPLE output directory. The full list of recognised input filetypes is available
[here](https://github.com/nf-core/oncoanalyser/blob/1.0.0/lib/Constants.groovy#L58-L90).
[here](https://github.com/nf-core/oncoanalyser/blob/dev/lib/Constants.groovy#L58-L90).

### Simple example

Expand Down Expand Up @@ -157,7 +157,7 @@ The typical command for running the pipeline is as follows:
```bash
nextflow run nf-core/oncoanalyser \
-profile docker \
-revision 1.0.0 \
-revision dev \
--mode <wgts|targeted> \
--genome <GRCh37_hmf|GRCh38_hmf> \
--input samplesheet.csv \
Expand Down Expand Up @@ -241,7 +241,7 @@ If you wish to share such profile (such as upload as supplementary material for
### Selecting processes

Most of the major components in `oncoanalyser` can be skipped using `--processes_exclude` (the full list of available
processes can be viewed [here](https://github.com/nf-core/oncoanalyser/blob/1.0.0/lib/Constants.groovy#L36-L56)).
processes can be viewed [here](https://github.com/nf-core/oncoanalyser/blob/dev/lib/Constants.groovy#L36-L56)).
Multiple processes can be given as a comma-separated list. While there are some use-cases for this feature (e.g.
skipping resource intensive processes such as VIRUSBreakend), it becomes more powerful when combined with existing
inputs as described in the following section.
Expand Down Expand Up @@ -284,7 +284,7 @@ And now run and skip variant calling:
```bash
nextflow run nf-core/oncoanalyser \
-profile docker \
-revision 1.0.0 \
-revision dev \
--mode wgts \
--processes_exclude markdups,amber,cobalt,gridss,gripss,sage,pave \
--genome GRCh38_hmf \
Expand Down Expand Up @@ -354,7 +354,7 @@ P1_wgts,P1,SC,tumor,rna,bam,/path/to/P1.SC.tumor.rna.wts.bam
```bash
nextflow run nf-core/oncoanalyser \
-profile docker \
-revision 1.0.0 \
-revision dev \
--mode wgts \
--genome GRCh38_hmf \
--prepare_reference_only \
Expand All @@ -363,7 +363,7 @@ nextflow run nf-core/oncoanalyser \
```

Executing the above command will download and unpack default reference data without running any analysis, and once
complete the prepared reference files can found in `./prepare_reference/reference_data/1.0.0/<datetimestamp>/`. It is
complete the prepared reference files can found in `./prepare_reference/reference_data/1.1.0dev/<datetimestamp>/`. It is
recommended to remove the Nextflow work directory after staging data to free disk space.

For `oncoanalyser` to use locally staged reference data a custom config can be used:
Expand Down Expand Up @@ -455,7 +455,7 @@ config file. This avoids having to regenerate indexes for each new analysis.
```bash
nextflow run nf-core/oncoanalyser \
-profile docker \
-revision 1.0.0 \
-revision dev \
-config genome.custom.config \
--mode wgts \
\
Expand Down
2 changes: 1 addition & 1 deletion nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ manifest {
description = """A comprehensive cancer DNA/RNA analysis and reporting pipeline"""
mainScript = 'main.nf'
nextflowVersion = '!>=22.10.5'
version = '1.0.0'
version = '1.1.0dev'
doi = ''
}

Expand Down

0 comments on commit bdcb87d

Please sign in to comment.