Skip to content

Commit 49b6945

Browse files
committed
Try some folding directory listings
1 parent a35789d commit 49b6945

File tree

5 files changed

+263
-233
lines changed

5 files changed

+263
-233
lines changed

docs/hello_nf-core/00_orientation.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,24 @@ tree . -L 2
7171

7272
If you run this inside `hello-nf-core`, you should see the following output:
7373

74-
```console title="Directory contents"
75-
.
76-
├── greetings.csv
77-
├── original-hello
78-
│ ├── hello.nf
79-
│ ├── modules
80-
│ └── nextflow.config
81-
└── solutions
82-
├── composable-hello
83-
├── core-hello-part2
84-
├── core-hello-part3
85-
├── core-hello-part4
86-
└── core-hello-start
87-
88-
8 directories, 3 files
89-
```
74+
??? example "Directory contents"
75+
76+
```console
77+
.
78+
├── greetings.csv
79+
├── original-hello
80+
│ ├── hello.nf
81+
│ ├── modules
82+
│ └── nextflow.config
83+
└── solutions
84+
├── composable-hello
85+
├── core-hello-part2
86+
├── core-hello-part3
87+
├── core-hello-part4
88+
└── core-hello-start
89+
90+
8 directories, 3 files
91+
```
9092

9193
**Here's a summary of what you should know to get started:**
9294

docs/hello_nf-core/01_run_demo.md

Lines changed: 108 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,13 @@ By default, Nextflow saves them to `$NXF_HOME/assets`.
9797
tree -L 2 $NXF_HOME/assets/
9898
```
9999

100-
```console title="Output"
101-
/workspaces/.nextflow/assets/
102-
└── nf-core
103-
└── demo
104-
```
100+
??? example "Directory contents"
101+
102+
```console
103+
/workspaces/.nextflow/assets/
104+
└── nf-core
105+
└── demo
106+
```
105107

106108
!!! note
107109

@@ -122,11 +124,13 @@ This creates a shortcut that makes it easier to explore the code we just downloa
122124
tree -L 2 pipelines
123125
```
124126

125-
```console title="Output"
126-
pipelines
127-
└── nf-core
128-
└── demo
129-
```
127+
??? example "Directory contents"
128+
129+
```console
130+
pipelines
131+
└── nf-core
132+
└── demo
133+
```
130134

131135
Now we can more easily peek into the source code as needed.
132136

@@ -294,28 +298,30 @@ Finally, let's have a look at the `demo-results` directory produced by the pipel
294298
tree -L 2 demo-results
295299
```
296300

297-
```console title="Output"
298-
demo-results/
299-
├── fastqc
300-
│ ├── SAMPLE1_PE
301-
│ ├── SAMPLE2_PE
302-
│ └── SAMPLE3_SE
303-
├── fq
304-
│ ├── SAMPLE1_PE
305-
│ ├── SAMPLE2_PE
306-
│ └── SAMPLE3_SE
307-
├── multiqc
308-
│ ├── multiqc_data
309-
│ ├── multiqc_plots
310-
│ └── multiqc_report.html
311-
└── pipeline_info
312-
├── execution_report_2025-03-05_09-44-26.html
313-
├── execution_timeline_2025-03-05_09-44-26.html
314-
├── execution_trace_2025-03-05_09-44-26.txt
315-
├── nf_core_pipeline_software_mqc_versions.yml
316-
├── params_2025-03-05_09-44-29.json
317-
└── pipeline_dag_2025-03-05_09-44-26.html
318-
```
301+
??? example "Directory contents"
302+
303+
```console
304+
demo-results/
305+
├── fastqc
306+
│ ├── SAMPLE1_PE
307+
│ ├── SAMPLE2_PE
308+
│ └── SAMPLE3_SE
309+
├── fq
310+
│ ├── SAMPLE1_PE
311+
│ ├── SAMPLE2_PE
312+
│ └── SAMPLE3_SE
313+
├── multiqc
314+
│ ├── multiqc_data
315+
│ ├── multiqc_plots
316+
│ └── multiqc_report.html
317+
└── pipeline_info
318+
├── execution_report_2025-03-05_09-44-26.html
319+
├── execution_timeline_2025-03-05_09-44-26.html
320+
├── execution_trace_2025-03-05_09-44-26.txt
321+
├── nf_core_pipeline_software_mqc_versions.yml
322+
├── params_2025-03-05_09-44-29.json
323+
└── pipeline_dag_2025-03-05_09-44-26.html
324+
```
319325

320326
If you're curious about the specifics of what that all means, check out [the nf-core/demo pipeline documentation page](https://nf-co.re/demo/1.0.2/).
321327

@@ -348,28 +354,30 @@ You can either use `tree` or use the file explorer in your IDE.
348354
tree -L 1 pipelines/nf-core/demo
349355
```
350356

351-
```console title="Output (top-level only)"
352-
pipelines/nf-core/demo
353-
├── assets
354-
├── CHANGELOG.md
355-
├── CITATIONS.md
356-
├── CODE_OF_CONDUCT.md
357-
├── conf
358-
├── docs
359-
├── LICENSE
360-
├── main.nf
361-
├── modules
362-
├── modules.json
363-
├── nextflow.config
364-
├── nextflow_schema.json
365-
├── nf-test.config
366-
├── README.md
367-
├── ro-crate-metadata.json
368-
├── subworkflows
369-
├── tests
370-
├── tower.yml
371-
└── workflows
372-
```
357+
??? example "Directory contents"
358+
359+
```console
360+
pipelines/nf-core/demo
361+
├── assets
362+
├── CHANGELOG.md
363+
├── CITATIONS.md
364+
├── CODE_OF_CONDUCT.md
365+
├── conf
366+
├── docs
367+
├── LICENSE
368+
├── main.nf
369+
├── modules
370+
├── modules.json
371+
├── nextflow.config
372+
├── nextflow_schema.json
373+
├── nf-test.config
374+
├── README.md
375+
├── ro-crate-metadata.json
376+
├── subworkflows
377+
├── tests
378+
├── tower.yml
379+
└── workflows
380+
```
373381

374382
There's a lot going on in there, so we'll tackle this in stages.
375383
We're going to look at the following categories:
@@ -399,10 +407,12 @@ The central logic of the pipeline is stored inside the `workflows` folder, in a
399407
tree pipelines/nf-core/demo/workflows
400408
```
401409

402-
```console title="Output"
403-
pipelines/nf-core/demo/workflows
404-
└── demo.nf
405-
```
410+
??? example "Directory contents"
411+
412+
```console
413+
pipelines/nf-core/demo/workflows
414+
└── demo.nf
415+
```
406416

407417
`main.nf` also calls a few 'housekeeping' subworkflows that we're going to ignore for now.
408418

@@ -436,26 +446,28 @@ The module code file describing the process is always called `main.nf`, and is a
436446
tree -L 3 pipelines/nf-core/demo/modules
437447
```
438448

439-
```console title="Output"
440-
pipelines/nf-core/demo/modules
441-
└── nf-core
442-
├── fastqc
443-
│   ├── environment.yml
444-
│   ├── main.nf
445-
│   ├── meta.yml
446-
│   └── tests
447-
├── multiqc
448-
│   ├── environment.yml
449-
│   ├── main.nf
450-
│   ├── meta.yml
451-
│   └── tests
452-
└── seqtk
453-
└── trim
454-
├── environment.yml
455-
├── main.nf
449+
??? example "Directory contents"
450+
451+
```console
452+
pipelines/nf-core/demo/modules
453+
└── nf-core
454+
├── fastqc
455+
│   ├── environment.yml
456+
│   ├── main.nf
457+
│   ├── meta.yml
458+
│   └── tests
459+
├── multiqc
460+
│   ├── environment.yml
461+
│   ├── main.nf
462+
│   ├── meta.yml
463+
│   └── tests
464+
└── seqtk
465+
└── trim
466+
├── environment.yml
467+
├── main.nf
456468
├── meta.yml
457469
└── tests
458-
```
470+
```
459471

460472
Here you see that the `fastqc` and `multiqc` modules sit at the top level within the `nf-core` modules, whereas the `trim` module sits under the toolkit that it belongs to, `seqtk`.
461473
In this case there are no `local` modules.
@@ -470,25 +482,27 @@ In an nf-core pipeline, the subworkflows are divided into `local` and `nf-core`
470482
tree -L 3 pipelines/nf-core/demo/subworkflows
471483
```
472484

473-
```console title="Output"
474-
pipelines/nf-core/demo/subworkflows
475-
├── local
476-
│   └── utils_nfcore_demo_pipeline
477-
│   └── main.nf
478-
└── nf-core
479-
├── utils_nextflow_pipeline
480-
│   ├── main.nf
481-
│   ├── meta.yml
482-
│   └── tests
483-
├── utils_nfcore_pipeline
484-
│   ├── main.nf
485-
│   ├── meta.yml
486-
│   └── tests
487-
└── utils_nfschema_plugin
488-
├── main.nf
489-
├── meta.yml
485+
??? example "Directory contents"
486+
487+
```console
488+
pipelines/nf-core/demo/subworkflows
489+
├── local
490+
│   └── utils_nfcore_demo_pipeline
491+
│   └── main.nf
492+
└── nf-core
493+
├── utils_nextflow_pipeline
494+
│   ├── main.nf
495+
│   ├── meta.yml
496+
│   └── tests
497+
├── utils_nfcore_pipeline
498+
│   ├── main.nf
499+
│   ├── meta.yml
500+
│   └── tests
501+
└── utils_nfschema_plugin
502+
├── main.nf
503+
├── meta.yml
490504
└── tests
491-
```
505+
```
492506

493507
In the case of the `nf-core/demo` pipeline, the subworkflows involved are all 'utility' or housekeeping subworkflows, as denoted by the `utils_` prefix in their names.
494508
These subworkflows are what produces the fancy nf-core header in the console output, among other accessory functions.

0 commit comments

Comments
 (0)