-
Notifications
You must be signed in to change notification settings - Fork 213
Prototype of NF4 RNAseq mini-course #526
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
Merged
Merged
Changes from 15 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
003e72f
Stubs for RNAseq mini-course
vdauwera c233e15
Add RNAseq processing pipeline
vdauwera 646e9b0
Update workflow and modules solutions + outline instructions
vdauwera ab770bc
Added test data and genome index files
vdauwera 00bcfa3
Reordered to put MultiQC after multisample handling
vdauwera 14ca862
More dealing with paired-ends
vdauwera bdbe4ab
fix genome index archive
vdauwera 398eee9
Add input CSVs + differentiate batch name
vdauwera e16ecfe
Add NF4 RNAseq to nav/menu
vdauwera ae8b853
Complete instructions for Part 1
vdauwera 29b5ba3
Tiny title change
vdauwera 49e5590
Complete instructions for Part 2
vdauwera 87d6ac0
Instructions for Part 3 are almost complete
vdauwera 9b94585
Complete instructions for Part 3
vdauwera e0ffbd7
Merge branch 'master' into gvda-nf4rnaseq-prototype
vdauwera 6509201
Address Ken's review
vdauwera fd9007f
Address the data problem
vdauwera fc01b4d
Update the meta pages
vdauwera e4b8d17
Apply suggestions from ken's code review
vdauwera cb52f56
Minor language tweak
vdauwera 1583f8c
Tiny fix
vdauwera 41760a9
Merge branch 'master' into gvda-nf4rnaseq-prototype
vdauwera File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Orientation | ||
|
||
The training 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. | ||
|
||
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 `nf4-science/rnaseq/` directory, which you need to move into when you open the training workspace. | ||
This directory contains all the code files, test data and accessory files you will need. | ||
|
||
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 training workspace in the VSCode interface. | ||
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. | ||
|
||
Here we generate a table of contents to the second level down: | ||
|
||
```bash | ||
tree . -L 2 | ||
``` | ||
|
||
If you run this inside `nf4-science/rnaseq`, you should see the following output: | ||
|
||
```console title="Directory contents" | ||
|
||
TODO | ||
|
||
``` | ||
|
||
!!!note | ||
|
||
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 file `nextflow.config`** is a configuration file that sets minimal environment properties. | ||
You can ignore it for now. | ||
|
||
- **The `data` directory** contains input data and related resources: | ||
- _A reference genome_ consisting of a small region of the human chromosome 20 (from hg19/b37) and its accessory files (index and known splice sites). | ||
- _RNAseq data_ corresponding to **[contents]**, which have been subset to a **[region?]** to keep the file sizes small. | ||
|
||
_Completed workflows (solutions) will be added in the near future._ | ||
|
||
<!-- COMMENTED OUT UNTIL SOLUTIONS ARE READY (need to redo them) | ||
- **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 `genomics-1-4.nf` is the expected result of completing steps 1 through 4 of _Part 1: Per-sample variant calling_ using the `genomics-1.nf` workflow. | ||
--> | ||
|
||
!!!tip | ||
|
||
If for whatever reason you move out of this directory, you can always run this command to return to it: | ||
|
||
```bash | ||
cd /workspaces/training/nf4-science/rnaseq | ||
``` | ||
|
||
Now, to begin the course, click on the arrow in the bottom right corner of this page. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.