Skip to content

Commit

Permalink
Updated bwa_index parameter to accept only directories
Browse files Browse the repository at this point in the history
  • Loading branch information
DSchreyer committed Feb 4, 2024
1 parent 4deb7d4 commit 1f94fb6
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,16 @@ Now, you can run the pipeline using:
nextflow run nf-core/circdna --input samplesheet.csv --outdir <OUTDIR> --genome GRCh38 -profile <docker/singularity/podman/shifter/charliecloud/conda/institute> --circle_identifier <CIRCLE_IDENTIFIER> --input_format <"FASTQ"/"BAM">
```

### Test AmpliconSuite-Pipeline with a test data-set

To test the correct instllatiion of the pipeline and the use of AmpliconArchitect inside the [AmpliconSuite-Pipeline](https://github.com/AmpliconSuite/AmpliconSuite-pipeline), a small WGS data set is uploaded to [AWS](https://aws.amazon.com/) and can be downloaded and used with the parameter `-profile test_AA_local`. You just need to specify your local paths to the `aa_data_repo` and the `mosek_license_dir`. See [AmpliconSuite-Pipeline](https://github.com/AmpliconSuite/AmpliconSuite-pipeline) for information about the data repository and the Mosek license. To note, the Mosek license file needs to be named `mosek.lic`.

You can test the pipeline using:

```bash
nextflow run nf-core/circdna -profile test_AA_local,<docker/singularity/podman/shifter/charliecloud/conda/institute> --outdir <OUTDIR> --aa_data_repo <path/to/aa_data_repo/> --mosek_license_dir <path/to/mosek_license_directory/>
```

## Available ecDNA identifiers

Please specify the parameter `circle_identifier` depending on the pipeline branch used for circular DNA identifaction. Please note that some branches/software are only tested with specific NGS data sets.
Expand All @@ -92,7 +102,7 @@ Please specify the parameter `circle_identifier` depending on the pipeline branc
### Identification of amplified ecDNAs with WGS data

> `ampliconarchitect` uses [AmpliconArchitect](https://github.com/jluebeck/AmpliconArchitect)
> `ampliconarchitect` uses [AmpliconArchitect](https://github.com/jluebeck/AmpliconArchitect) inside the [AmpliconSuite-Pipeline](https://github.com/AmpliconSuite/AmpliconSuite-pipeline)
### De novo assembly of ecDNAs with Circle-seq data

Expand Down
5 changes: 2 additions & 3 deletions nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,9 @@
},
"bwa_index": {
"type": "string",
"format": "file-path",
"format": "directory-path",
"mimetype": "text/plain",
"pattern": "^\\S+\\.\\{amb,ann,bwt,pac,sa\\}$",
"description": "Path to BWA Index genome file.",
"description": "Path to the directory containg the BWA index files.",
"help_text": "This parameter is *optional*. If you don't have a BWA index available this will be generated for you automatically.",
"fa_icon": "far fa-file-code"
}
Expand Down
11 changes: 6 additions & 5 deletions workflows/circdna.nf
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,13 @@ if (!params.input) { exit 1, 'Input samplesheet not specified!' }

// Check if BWA Index is given
if (params.bwa_index) {
ch_bwa_index = Channel.fromPath(params.bwa_index).collect()
ch_bwa_index = Channel.fromPath(params.bwa_index, type: 'dir').collect()
ch_bwa_index = ch_bwa_index.map{ index -> ["bwa_index", index] }.collect()
bwa_index_exists = true
} else {
ch_bwa_index = Channel.empty()
bwa_index_exists = false
}
} else {
ch_bwa_index = Channel.empty()
bwa_index_exists = false
}

// AMPLICON ARCHITECT INPUT
if (run_ampliconarchitect) {
Expand Down

0 comments on commit 1f94fb6

Please sign in to comment.