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

Updates to the wording and tree output #417

Merged
merged 1 commit into from
Oct 27, 2024
Merged
Changes from all commits
Commits
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
109 changes: 61 additions & 48 deletions docs/hello_nextflow/01_orientation.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,93 @@
# Orientation

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.
The Gitpod environment contains all the software, code and data necessary to work through this training course, so you don't need to install anything yourself.
However, you do need a (free) account to log in, and you should take a few minutes to familiarize yourself with the interface.

!!! note

Follow [this link](../../envsetup/) if you have not yet set up your Gitpod environment.
If you have not yet done so, please follow [this link](../../envsetup/) before going any further.

## Materials provided

Throughout this training course, we'll be working in the `hello-nextflow/` directory.
Throughout this training course, we'll be working in the `hello-nextflow/` directory, which loads by default when you open the Gitpod workspace.
This directory contains all the code files, test data and accessory files you will need.

```bash
cd /workspace/gitpod/hello-nextflow
```
Feel free to explore the contents of this directory; the easiest way to do so is to use the file explorer on the left hand side of the Gitpod workspace.
Alternatively, you can use the `tree` command.
Throughout the course, we use the output of `tree` to represent directory structure and contents in a readable form, sometimes with minor modifications for clarity.

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).
Here we generate a table of contents to the second level down:

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

You should see the following output: **TODO: UPDATE**
If you run this inside `hello-nextflow`, you should see the following output:

```console title="Directory contents"
/workspace/gitpod/hello-nextflow
.
├── containers
│ ├── build
│ ├── data
│ ├── results
│ └── scripts
├── data
│ ├── bam
│ ├── greetings.csv
│ ├── ref
│ ├── sample_bams.txt
│ └── samplesheet.csv
├── hello-gatk.nf
├── hello-modules.nf
├── hello-nf-test.nf
├── hello-config
│ ├── demo-params.json
│ ├── main.nf
│ └── nextflow.config
├── hello-containers.nf
├── hello-genomics.nf
├── hello-modules
│ ├── demo-params.json
│ ├── main.nf
│ └── nextflow.config
├── hello-nf-test
│ ├── demo-params.json
│ ├── main.nf
│ └── nextflow.config
├── hello-operators.nf
├── hello-world.nf
├── nextflow.config
└── solutions
├── 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
├── hello-gatk-4.nf
├── hello-gatk-5.nf
├── hello-gatk-6.nf
├── hello-modules-1.nf
├── hello-modules-2.nf
├── hello-modules-3.nf
├── hello-world-1.nf
├── hello-world-2.nf
├── hello-world-3.nf
├── hello-world-4.nf
├── hello-world-5.nf
├── hello-world-6.nf
├── hello-world-7.nf
├── hello-world-8.nf
├── hello-world-9.nf
├── modules
└── nextflow.config

13 directories, 48 files

├── hello-config
├── hello-genomics
├── hello-modules
├── hello-nf-test
├── hello-operators
└── hello-world

18 directories, 17 files
```

**The `data` directory** contains the input data we'll use in Part 3: Hello Genomics, which uses an example from genomics to demonstrate how to build a simple analysis pipeline.
The dataset is described in detail in that section of the course.
Don't worry if this seems like a lot; we'll go through the relevant pieces at each step of the course.
This is just meant to give you an overview.

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

**The `.nf` files** are workflow scripts that are named based on what part of the course they're used in.

**The `hello-*` directories** are directories used in the later Parts of the course where we are working with more than just one workflow file.

**The file `nextflow.config`** is a configuration file that sets minimal environment properties.
You can ignore it for now.

**The `data` directory** contains the input data we'll use in most of the course. The dataset is described in detail in Part 3, when we introduce it for the first time.

**The `solutions` 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.

**The file `hello-world.nf`** is a simple but fully functional workflow script that serves as a starting point to Part 1: Hello World.
!!!tip

**The file `hello-gatk.nf`** is a stub that serves as a starting point to Part 3: Hello Genomics.
In its initial state, it is NOT a functional workflow script.
If for whatever reason you move out of this directory, you can always run this command to return to it:

**The remaining `.nf` files** are functional workflow scripts that serve as starting points for the corresponding parts of the course.
```bash
cd /workspace/gitpod/hello-nextflow
```

**The `solutions` directory** contains the completed workflow scripts and other files that you will generate in each part 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.
Now, to begin the course, click on the arrow in the bottom right corner of this page.
Loading