Skip to content

Commit b9dd257

Browse files
committed
fixing linting, modifying docs
1 parent 7b27f82 commit b9dd257

5 files changed

Lines changed: 17 additions & 49 deletions

File tree

.nf-core.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ lint:
3636
- .github/ISSUE_TEMPLATE/bug_report.yml
3737
multiqc_config:
3838
- report_comment
39-
nextflow_config:
40-
- manifest.name
41-
- manifest.homePage
39+
nextflow_config: false
40+
# - manifest.name
41+
# - manifest.homePage
4242
nf_test_content: False
4343
nf_core_version: 3.3.2
4444
repository_type: pipeline

docs/usage.md

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,25 @@
44
55
## Introduction
66

7-
<!-- nf-core: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website. -->
87

98
## Samplesheet input
109

11-
You will need to create a samplesheet with information about the samples you would like to analyse before running the pipeline. Use this parameter to specify its location. It has to be a comma-separated file with 3 columns, and a header row as shown in the examples below.
10+
You will need to create a samplesheet with information about the samples you would like to analyse before running the pipeline. Use this parameter to specify its location. It has to be a comma-separated file with 4 columns, and a header row as shown in the examples below. It is best to specify this input parameter in `nextflow.config` or your own custom config file.
1211

1312
```bash
1413
--input '[path to samplesheet file]'
1514
```
16-
17-
### Multiple runs of the same sample
18-
19-
The `sample` identifiers have to be the same when you have re-sequenced the same sample more than once e.g. to increase sequencing depth. The pipeline will concatenate the raw reads before performing any downstream analysis. Below is an example for the same sample sequenced across 3 lanes:
20-
21-
```csv title="samplesheet.csv"
22-
sample,fastq_1,fastq_2
23-
CONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz
24-
CONTROL_REP1,AEG588A1_S1_L003_R1_001.fastq.gz,AEG588A1_S1_L003_R2_001.fastq.gz
25-
CONTROL_REP1,AEG588A1_S1_L004_R1_001.fastq.gz,AEG588A1_S1_L004_R2_001.fastq.gz
26-
```
27-
2815
### Full samplesheet
2916

30-
The pipeline will auto-detect whether a sample is single- or paired-end using the information provided in the samplesheet. 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.
17+
The pipeline will auto-detect whether the sequencing summary files, and reads are in the paths listed on the samplesheet. Each row represents a fastq file. Replicate refers to a technical replicate, biological replicates should be named uniquely. Be sure to pay attention to sample naming, in
18+
order to avoid duplication and file overwriting.
3119

32-
A final samplesheet file consisting of both single- and paired-end data may look something like the one below. This is for 6 samples, where `TREATMENT_REP3` has been sequenced twice.
20+
A final samplesheet file consisting of long-read data may look something like the one below. This is for **one biological** sample which has been sequenced twice, giving two technical replicates.
3321

3422
```csv title="samplesheet.csv"
35-
sample,fastq_1,fastq_2
36-
CONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz
37-
CONTROL_REP2,AEG588A2_S2_L002_R1_001.fastq.gz,AEG588A2_S2_L002_R2_001.fastq.gz
38-
CONTROL_REP3,AEG588A3_S3_L002_R1_001.fastq.gz,AEG588A3_S3_L002_R2_001.fastq.gz
39-
TREATMENT_REP1,AEG588A4_S4_L003_R1_001.fastq.gz,
40-
TREATMENT_REP2,AEG588A5_S5_L003_R1_001.fastq.gz,
41-
TREATMENT_REP3,AEG588A6_S6_L003_R1_001.fastq.gz,
42-
TREATMENT_REP3,AEG588A6_S6_L004_R1_001.fastq.gz,
23+
sample,replicate,sequencing_summary_path,read_path
24+
CONTROL1,1,data/long_reads_sequencingsummary_1.txt,data/long_reads_1.fastq.gz
25+
CONTROL1,2,data/long_reads_sequencingsummary_2.txt,data/long_reads_2.fastq.gz
4326
```
4427

4528
| Column | Description |

modules/local/isoquant/gtf2db/nextflow.config

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,3 @@
66
]
77
}
88
}
9-

nextflow.config

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,16 +129,15 @@ params {
129129
config_profile_name = null
130130
config_profile_description = null
131131
custom_config_version = 'dev'
132-
//custom_config_base = "https://raw.githubusercontent.com/nf-core/configs/${params.custom_config_version}"
133-
//custom_config_base = 'https://raw.githubusercontent.com/nf-core/configs/dev'
132+
custom_config_base = 'conf/base.config'
134133
config_profile_contact = 'deancombio@pm.me'
135134
config_profile_url = ''
136135

137136
// Max resource options
138137
// Defaults only, expecting to be overwritten
139-
max_memory = '32.GB'
140-
max_cpus = 10
141-
max_time = '48.h'
138+
//max_memory = '32.GB'
139+
//max_cpus = 10
140+
//max_time = '48.h'
142141

143142
// Schema validation default options
144143
//validationFailUnrecognisedParams = false

nextflow_schema.json

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,8 @@
158158
},
159159
"custom_config_base": {
160160
"type": "string",
161-
"description": "Base directory for Institutional configs."
161+
"description": "Base directory for Institutional configs.",
162+
"default": "conf/base.config"
162163
},
163164
"config_profile_contact": {
164165
"type": "string",
@@ -397,19 +398,5 @@
397398
{
398399
"$ref": "#/$defs/module_specific_options"
399400
}
400-
],
401-
"properties": {
402-
"max_memory": {
403-
"type": "string",
404-
"default": "32.GB"
405-
},
406-
"max_cpus": {
407-
"type": "integer",
408-
"default": 10
409-
},
410-
"max_time": {
411-
"type": "string",
412-
"default": "48.h"
413-
}
414-
}
401+
]
415402
}

0 commit comments

Comments
 (0)