Skip to content

Commit a217ca2

Browse files
committed
Remove markdownlint and prettier processing for
manual_tests.md
1 parent f12c425 commit a217ca2

5 files changed

Lines changed: 12 additions & 9 deletions

File tree

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ adaptivecard.json
33
slackreport.json
44
.nextflow*
55
work/
6+
docs/manual_tests.md
67
data/
78
results/
89
.DS_Store

docs/development/code_conventions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ The alias should ideally make it intuitive to understand which subworkflow the m
2727

2828
- The unique module names specified above should make it possible to always configure modules without the need for a regex/glob when using `withName`. Exception to this is modules named within nf-core subworkflows, which should be configured with a regex/glob.
2929
- The order of attributes within configuration blocks should always be the following:
30-
1. tag (mandatory)
31-
2. ext.args\* (optional. Followed by ext.args{2,3,...} in ascending order)
32-
3. ext.prefix (optional)
33-
4. publishDir (optional)
34-
5. any other attributes go to the end.
30+
1. tag (mandatory)
31+
2. ext.args\* (optional. Followed by ext.args{2,3,...} in ascending order)
32+
3. ext.prefix (optional)
33+
4. publishDir (optional)
34+
5. any other attributes go to the end.
3535
- NEVER use `meta.id` in module configuration (`tag`,`ext.*`), but instead the full explicit combination of unique attributes expected. `meta.sample_id` is fine to use and is equivalent to `meta.id`, but should be supplemented by `meta.library_id` and `meta.lane` etc, as required.
3636
- Every process that is reference-specific MUST include `${meta.reference}` in its `tag` and `ext.prefix` attributes. This is to avoid confusion when running the pipeline with multiple references.
3737
- Tags that include reference and sample information should be formatted as `${meta.reference}|${meta.sample_id}_*`. Reference specific attributes go on the left-hand-side of the tag, data-specific attributes on the right-hand-side.

docs/development/dev_docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To add new input files or options to the reference sheet, you have to complete a
1616

1717
### Multi-reference input workflow
1818

19-
1. Add new column named <SOFTWARE_FILETYPE> and test data to the test reference sheet (https://github.com/nf-core/test-datasets/blob/eager/reference/reference_sheet_multiref.csv).
19+
1. Add new column named <SOFTWARE_FILETYPE> and test data to the test reference sheet (<https://github.com/nf-core/test-datasets/blob/eager/reference/reference_sheet_multiref.csv>).
2020
2. Read in new input via nf-validation plugin within the reference_indexing_multi local subworkflow.
2121
1. Add new "property" <SOFTWARE_FILETYPE> to the fasta validation schema (assets/schema_fasta.json).
2222
1. Add "type" of your object, e.g. `"type": "string"` for file paths and `"type": "integer"` for numbers.

docs/development/manual_tests.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable -->
12
# Manual Tests
23

34
Here is a list of manual tests we can run with the expect output commands
@@ -1146,4 +1147,5 @@ nextflow run main.nf -profile docker,test --outdir ./results/mtdna_haplogroup_te
11461147
## Expect: Directory created 'mtdna_haplogroup/<reference>/<sample_id>' containing a .txt file for each sample with haplogroup assignments
11471148
## Expect: The haplogroup assignment may differ based on the classification settings
11481149
nextflow run main.nf -profile docker,test --outdir ./results/mtdna_haplogroup_test --run_classify_mtdna_haplogroup --run_genotyping --genotyping_tool ug --genotyping_source raw --haplogrep3_tree_id phylotree-fu-rcrs@1.2 -resume
1149-
```
1150+
```
1151+
<!-- markdownlint-enable -->

docs/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Only the `reference_name`, and `fasta` columns are mandatory, whereas all other
107107

108108
Files for `fai`, `dict`, `mapper_index` will be generated by the pipeline for you if not specified.
109109

110-
A real-world example could look as follows, where a user-supplied `.dict` file and `circular_target ` and `mitochondrion_header` are not specified:
110+
A real-world example could look as follows, where a user-supplied `.dict` file and `circular_target` and `mitochondrion_header` are not specified:
111111

112112
```txt
113113
reference_name,fasta,fai,dict,mapper_index,circular_target,mitochondrion
@@ -217,7 +217,7 @@ If `-profile` is not specified, the pipeline will run locally and expect all sof
217217
- `apptainer`
218218
- A generic configuration profile to be used with [Apptainer](https://apptainer.org/)
219219
- `wave`
220-
- A generic configuration profile to enable [Wave](https://seqera.io/wave/) containers. Use together with one of the above (requires Nextflow ` 24.03.0-edge` or later).
220+
- A generic configuration profile to enable [Wave](https://seqera.io/wave/) containers. Use together with one of the above (requires Nextflow `24.03.0-edge` or later).
221221
- `conda`
222222
- A generic configuration profile to be used with [Conda](https://conda.io/docs/). Please only use Conda as a last resort i.e. when it's not possible to run the pipeline with Docker, Singularity, Podman, Shifter, Charliecloud, or Apptainer.
223223

0 commit comments

Comments
 (0)