Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Hello-channels, stub for containers etc and reorder training modules #391

Merged
merged 33 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
a8053fb
Reorder training modules
vdauwera Oct 10, 2024
a742f16
Remove GVCF and joint genotyping from Hello-GATK
vdauwera Oct 10, 2024
9f4c1d0
Start updating the channels stub
vdauwera Oct 10, 2024
2b4271f
Add introductory explanations
vdauwera Oct 10, 2024
1048622
Added joint genotyping to Hello-channels
vdauwera Oct 17, 2024
08bc0fb
Prettier fixes
vdauwera Oct 17, 2024
808cccb
Merge branch 'master' into gvda-hello-channels
vdauwera Oct 17, 2024
61f16de
Finish converting the splitText to splitCsv
vdauwera Oct 17, 2024
39496f5
Merge branch 'gvda-hello-channels' of https://github.com/nextflow-io/…
vdauwera Oct 17, 2024
45f0954
Prettier fixes
vdauwera Oct 17, 2024
17c9fcc
Merge branch 'master' into gvda-hello-channels
vdauwera Oct 19, 2024
60f6576
Update TOC in YML file
vdauwera Oct 19, 2024
3ea1bd5
Fix TOC and update ordinals
vdauwera Oct 19, 2024
428cc7e
Add stubs for planned modules and update order/ordinals
vdauwera Oct 19, 2024
0e6ba88
Prettier fixes
vdauwera Oct 19, 2024
d06918d
Merge branch 'master' into gvda-hello-channels
vdauwera Oct 20, 2024
1df2b45
More explanations to GATK docs
vdauwera Oct 20, 2024
3db5f18
A few more GATK explanations
vdauwera Oct 20, 2024
ede11a3
Complete explanations for hello gatk
vdauwera Oct 20, 2024
851476a
Improvements to Orientation + Hello World instructions
vdauwera Oct 21, 2024
58c0469
Tiny addition to introduction
vdauwera Oct 21, 2024
3a58c62
Minor tweaks to Part 3 (GATK) instructions
vdauwera Oct 21, 2024
b7daffc
Formatting fixes and minor language tweaks
vdauwera Oct 21, 2024
76b2bbf
Formatting fixes and updated outputs
vdauwera Oct 21, 2024
08d46a4
Minor fixes
vdauwera Oct 21, 2024
346d547
Language tweak
vdauwera Oct 22, 2024
0791a95
Improve formatting - Orientation
vdauwera Oct 22, 2024
6d6c9f1
Improve formatting - Hello World
vdauwera Oct 22, 2024
5d1ea5d
Improve formatting - Hello Channels
vdauwera Oct 22, 2024
cf9a84e
Improve formatting - GATK suggestions batch1
vdauwera Oct 22, 2024
4d4376b
Improve formatting - GATK suggestions batch2
vdauwera Oct 22, 2024
b446971
Small fixes + add JG flowchart
vdauwera Oct 22, 2024
dc14795
A few more formatting fixes
vdauwera Oct 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 24 additions & 47 deletions docs/hello_nextflow/01_orientation.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,33 @@
# Orientation

The Gitpod environment contains some test data that will be used in this workshop. All software required are already installed and configured in it too.
The Gitpod environment contains some test data that will be used in this training course. All software required is already installed and configured in it too.

!!! note

Follow [this link](../../envsetup/) if you have not yet setup your Gitpod environment.
Follow [this link](../../envsetup/) if you have not yet set up your Gitpod environment.

## Getting started
## Materials provided

You will complete this module in the `hello-nextflow/` folder.
Throughout this training course, we'll be working in the `hello-nextflow/` directory.

```bash
cd /workspace/gitpod/hello-nextflow
```

In this folder you will all test data, code and accessory needed to work through this training module.
This directory contains all the code files, test data and accessory files you will need. Feel free to explore the contents of this directory; an easy way to see what it contains is the use the `tree` command (here we generate a table of contents to the second level down).

!!! question "Exercise"

View all the folder and files in the `hello-nextflow` directory.

```console
tree .
```
```bash
tree . -L 2
```

You should see the following output:

```console title="Output"
```console title="Directory contents"
/workspace/gitpod/hello-nextflow
├── data
│ ├── bam
│ │ ├── reads_father.bam
│ │ ├── reads_mother.bam
│ │ └── reads_son.bam
│ ├── greetings.txt
│ ├── intervals.list
│ ├── ref.tar.gz
│ ├── greetings.csv
│ ├── ref
│ ├── sample_bams.txt
│ └── samplesheet.csv
├── hello-gatk.nf
Expand All @@ -44,6 +36,10 @@ You should see the following output:
├── hello-world.nf
├── nextflow.config
└── scripts
├── hello-config-1.config
├── hello-config-2.config
├── hello-config-3.config
├── hello-config-4.config
├── hello-gatk-1.nf
├── hello-gatk-2.nf
├── hello-gatk-3.nf
Expand All @@ -53,7 +49,6 @@ You should see the following output:
├── hello-modules-1.nf
├── hello-modules-2.nf
├── hello-modules-3.nf
├── hello-world-10.nf
├── hello-world-1.nf
├── hello-world-2.nf
├── hello-world-3.nf
Expand All @@ -64,40 +59,22 @@ You should see the following output:
├── hello-world-8.nf
├── hello-world-9.nf
├── modules
│ └── local
│ ├── gatk
│ │ ├── haplotypecaller
│ │ │ └── main.nf
│ │ └── jointgenotyping
│ │ ├── main.nf
│ │ └── tests
│ │ └── inputs
│ │ ├── family_trio_map.tsv
│ │ ├── reads_father.bam.g.vcf
│ │ ├── reads_father.bam.g.vcf.idx
│ │ ├── reads_mother.bam.g.vcf
│ │ ├── reads_mother.bam.g.vcf.idx
│ │ ├── reads_son.bam.g.vcf
│ │ └── reads_son.bam.g.vcf.idx
│ └── samtools
│ └── index
│ └── main.nf
└── nextflow.config

12 directories, 43 files
13 directories, 48 files

```

Each file will be used in this training module.

**The `data` directory** contains the input data we'll use in Part 2: Hello GATK, which uses an example from genomics to demonstrate how to build a simple analysis pipeline. The data is described in detail in that section of the training.
**The `data` directory** contains the input data we'll use in Part 3: Hello Science, which uses an example from genomics to demonstrate how to build a simple analysis pipeline.
The data are described in detail in that section of the course.

**The `scripts` directory** contains the completed workflow scripts that result from each step of the tutorial and are intended to be used as a reference to check your work. The name and number in the filename correspond to the step of the relevant tutorial. For example, the file `hello-world-4.nf` is the expected result of completing steps 1 through 4 of Part 1: Hello World.
**The file `nextflow.config`** is a configuration file that sets minimal environment properties.

**The file `greetings.txt`** is a plain text file used to provide inputs in Part 1: Hello World.
**The file `hello-world.nf`** is a simple but fully functional workflow script that serves as a starting point to Part 1: Hello World.

**The file `hello-gatk.nf`** is a stub that serves as a starting point to Part 2: Hello GATK. In its initial state, it is NOT a functional workflow script.
**The file `hello-gatk.nf`** is a stub that serves as a starting point to Part 3: Hello Science.
In its initial state, it is NOT a functional workflow script.

**The file `hello-world.nf`** is a simple but fully functional workflow script that serves as a starting point to Part 1: Hello World.
**The remaining `.nf` files** are functional workflow scripts that serve as starting points for the corresponding parts of the course.

**The file `nextflow.config`** is a configuration file that sets minimal environment properties.
**The `scripts` directory** contains the completed workflow scripts that result from each step of the course. They are intended to be used as a reference to check your work and troubleshoot any issues. The name and number in the filename correspond to the step of the relevant part of the course. For example, the file `hello-world-4.nf` is the expected result of completing steps 1 through 4 of Part 1: Hello World.
Loading
Loading