Skip to content

Commit

Permalink
fix: coding style
Browse files Browse the repository at this point in the history
  • Loading branch information
matq007 committed Aug 2, 2024
1 parent 54395fc commit df3a35b
Show file tree
Hide file tree
Showing 6 changed files with 115 additions and 116 deletions.
100 changes: 50 additions & 50 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,53 @@ name: Bug report
description: Report something that is broken or incorrect
labels: bug
body:
- type: textarea
id: description
attributes:
label: Description of the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: command_used
attributes:
label: Command used and terminal output
description: Steps to reproduce the behaviour. Please paste the command you used
to launch the pipeline and the output from your terminal.
render: console
placeholder: '$ nextflow run ...
Some output where something broke
'
- type: textarea
id: files
attributes:
label: Relevant files
description: 'Please drag and drop the relevant files here. Create a `.zip` archive
if the extension is not allowed.
Your verbose log file `.nextflow.log` is often useful _(this is a hidden file
in the directory where you launched the pipeline)_ as well as custom Nextflow
configuration files.
'
- type: textarea
id: system
attributes:
label: System information
description: '* Nextflow version _(eg. 23.04.0)_
* Hardware _(eg. HPC, Desktop, Cloud)_
* Executor _(eg. slurm, local, awsbatch)_
* Container engine: _(e.g. Docker, Singularity, Conda, Podman, Shifter, Charliecloud,
or Apptainer)_
* OS _(eg. CentOS Linux, macOS, Linux Mint)_
* Version of brickmanlab/primeseq _(eg. 1.1, 1.5, 1.8.2)_
'
- type: textarea
id: description
attributes:
label: Description of the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: command_used
attributes:
label: Command used and terminal output
description: Steps to reproduce the behaviour. Please paste the command you used
to launch the pipeline and the output from your terminal.
render: console
placeholder: "$ nextflow run ...
Some output where something broke
"
- type: textarea
id: files
attributes:
label: Relevant files
description: "Please drag and drop the relevant files here. Create a `.zip` archive
if the extension is not allowed.
Your verbose log file `.nextflow.log` is often useful _(this is a hidden file
in the directory where you launched the pipeline)_ as well as custom Nextflow
configuration files.
"
- type: textarea
id: system
attributes:
label: System information
description: "* Nextflow version _(eg. 23.04.0)_
* Hardware _(eg. HPC, Desktop, Cloud)_
* Executor _(eg. slurm, local, awsbatch)_
* Container engine: _(e.g. Docker, Singularity, Conda, Podman, Shifter, Charliecloud,
or Apptainer)_
* OS _(eg. CentOS Linux, macOS, Linux Mint)_
* Version of brickmanlab/primeseq _(eg. 1.1, 1.5, 1.8.2)_
"
2 changes: 1 addition & 1 deletion .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install nf-core
- name: Run nf-core lint
run: nf-core lint --dir ${GITHUB_WORKSPACE}
48 changes: 24 additions & 24 deletions .nf-core.yml
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
lint:
files_exist:
- CODE_OF_CONDUCT.md
- assets/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_dark.png
- .github/ISSUE_TEMPLATE/config.yml
- .github/workflows/awstest.yml
- .github/workflows/awsfulltest.yml
- .github/.dockstore.yml
- .github/workflows/branch.yml
- .github/workflows/linting_comment.yml
- conf/test.config
- conf/test_full.config
- .github/workflows/ci.yml
- CODE_OF_CONDUCT.md
- assets/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_dark.png
- .github/ISSUE_TEMPLATE/config.yml
- .github/workflows/awstest.yml
- .github/workflows/awsfulltest.yml
- .github/.dockstore.yml
- .github/workflows/branch.yml
- .github/workflows/linting_comment.yml
- conf/test.config
- conf/test_full.config
- .github/workflows/ci.yml
files_unchanged:
- .github/workflows/linting.yml
- CODE_OF_CONDUCT.md
- assets/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_dark.png
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/workflows/linting.yml
- CODE_OF_CONDUCT.md
- assets/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_light.png
- docs/images/nf-core-primeseq_logo_dark.png
- .github/ISSUE_TEMPLATE/bug_report.yml
multiqc_config:
- report_comment
- report_comment
nextflow_config:
- manifest.name
- manifest.homePage
- manifest.name
- manifest.homePage
nf_core_version: 2.14.1
repository_type: pipeline
template:
author:
- Martin Proks
- Nazmus Salehin
- Martin Proks
- Nazmus Salehin
description: PRIME-seq preprocessing pipeline
name: primeseq
prefix: brickmanlab
10 changes: 5 additions & 5 deletions assets/schema_input.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@
"errorMessage": "FastQ file for reads 2 cannot contain spaces and must have extension '.fq.gz' or '.fastq.gz'"
},
"plate_id": {
"type": "integer",
"pattern": "^\\d",
"errorMessage": "Plate ID with beads",
"meta": ["plate_id"]
}
"type": "integer",
"pattern": "^\\d",
"errorMessage": "Plate ID with beads",
"meta": ["plate_id"]
}
},
"required": ["sample", "fastq_1", "fastq_2", "plate_id"]
}
Expand Down
58 changes: 29 additions & 29 deletions assets/schema_wells.json
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/brickmanlab/primeseq/master/assets/schema_wells.json",
"title": "brickmanlab/primeseq pipeline - params.wells schema",
"description": "Schema for the file provided with params.wells",
"type": "array",
"items": {
"type": "object",
"properties": {
"pool": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Same name as Sample in samplesheet",
"meta": ["pool"]
},
"well": {
"type": "string",
"pattern": "^[A-Z][0-9]",
"errorMessage": "Well location like A1",
"meta": ["well"]
},
"sample": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Sample name must be provided and cannot contain spaces",
"meta": ["sample"]
}
},
"required": ["pool", "well", "sample"]
}
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/brickmanlab/primeseq/master/assets/schema_wells.json",
"title": "brickmanlab/primeseq pipeline - params.wells schema",
"description": "Schema for the file provided with params.wells",
"type": "array",
"items": {
"type": "object",
"properties": {
"pool": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Same name as Sample in samplesheet",
"meta": ["pool"]
},
"well": {
"type": "string",
"pattern": "^[A-Z][0-9]",
"errorMessage": "Well location like A1",
"meta": ["well"]
},
"sample": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Sample name must be provided and cannot contain spaces",
"meta": ["sample"]
}
},
"required": ["pool", "well", "sample"]
}
}
13 changes: 6 additions & 7 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,17 @@ CONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz,1

The samplesheet can have as many columns as you desire, however, there is a strict requirement for the first 3 columns to match those defined in the table below.


```csv title="samplesheet.csv"
sample,fastq_1,fastq_2,plate_id
CONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz,1
```

| Column | Description |
|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sample` | Custom sample name. This entry will be identical for multiple sequencing libraries/runs from the same sample. Spaces in sample names are automatically converted to underscores (`_`). |
| `fastq_1` | Full path to FastQ file for Illumina short reads 1. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
| `fastq_2` | Full path to FastQ file for Illumina short reads 2. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
| `plate_id`| Plate number which was used. Only two availabe. If not sure use 1. |
| Column | Description |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sample` | Custom sample name. This entry will be identical for multiple sequencing libraries/runs from the same sample. Spaces in sample names are automatically converted to underscores (`_`). |
| `fastq_1` | Full path to FastQ file for Illumina short reads 1. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
| `fastq_2` | Full path to FastQ file for Illumina short reads 2. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
| `plate_id` | Plate number which was used. Only two availabe. If not sure use 1. |

An [example samplesheet](../assets/samplesheet.csv) has been provided with the pipeline.

Expand Down

0 comments on commit df3a35b

Please sign in to comment.