Skip to content

Commit

Permalink
feat: added test to run GH actions
Browse files Browse the repository at this point in the history
  • Loading branch information
m-jahn committed Oct 24, 2024
1 parent 10d4382 commit 40b8877
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,8 @@ jobs:
matrix:
NXF_VER:
- "24.04.2"
- "latest-everything"
profile:
- "conda"
- "docker"
- "singularity"
test_name:
- "test"
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,17 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool

4. Test it on the minimal dataset included with this repository. Since `nf-core-crispriscreen` is not a canonical `nf-core` pipeline (yet), it is necessary to indicate the path to the pipeline folder after the `run` statement.

The generalized command to run the pipeline:
This is the generalized command to run the pipeline:

```console
nextflow run <path/to/nf-core-crispriscreen> -profile <docker/singularity/podman/shifter/charliecloud/conda/institute> --input <sample_sheet> --fasta <fasta_file> --outdir <path/to/output>
```

The command to run the pipeline on the enclosed test data using `Singularity` (recommended):
This will run the pipeline on the enclosed test data using `Singularity` (recommended):

```console
cd path/to/nf-core-crispriscreen
nextflow run ./ -profile singularity --input "assets/samplesheet.csv" --fasta "assets/library.fasta" --outdir "results"
nextflow run ./ -profile test,singularity --outdir ./results
```

> - The pipeline comes with config profiles called `docker`, `singularity`, `podman`, `shifter`, `charliecloud` and `conda` which instruct the pipeline to use the named tool for software management. For example, `-profile test,docker`.
Expand Down
3 changes: 3 additions & 0 deletions conf/test.config
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,7 @@ params {
max_cpus = 2
max_memory = '6.GB'
max_time = '6.h'

input = 'assets/samplesheet.csv'
fasta = 'assets/library.fasta'
}

0 comments on commit 40b8877

Please sign in to comment.