-
Notifications
You must be signed in to change notification settings - Fork 212
Add Hello nf-core training course #610
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 all commits
Commits
Show all changes
47 commits
Select commit
Hold shift + click to select a range
1135a2b
Course structure
vdauwera 0f6b03e
Add contents
vdauwera 2d8f1a6
First section of hello nf-core
vdauwera 6998635
Merge branch 'master' into gvda-hello-nf-core
vdauwera f5ec9c5
Add section 2 materials + update index
vdauwera 4ec4bf8
small fix
vdauwera 5513168
tiny fix
vdauwera 11e2302
Add WoW Side Quest as a prelude
vdauwera cb0d5b3
Replace WoW case by Hello Nextflow original
vdauwera c40f120
fix modules location
vdauwera ef8c6e6
add greetings.csv input for nf-core
vdauwera 844dc04
change dir name for starting case
vdauwera 4dd4a30
original hello complete
vdauwera 6f7d94a
composable workflow is composable
vdauwera b8a283e
nf-core conversion of hello nextflow complete
vdauwera a35a86c
fix note formatting
vdauwera 0c43c02
change compliant to compatible to avoid overselling
vdauwera 1e429db
fix numbers formatting
vdauwera 06fa7eb
a few more minor fixes
vdauwera f7b512c
minor fixes
vdauwera 7e933ce
Minor improvements to orientation and demo run section
vdauwera e6c3fc8
added schemas and example samplesheet details
vdauwera c403c48
Improved Hello rewrite
vdauwera 03a6104
deleting due to weirdness
vdauwera 2f72b53
Start and end states of core-hello (minus the git file)
vdauwera 95db085
Improvements based on Summit trial run
vdauwera e95bc18
fixed headings
vdauwera ce429c0
Apply suggestions from Ken's code review
vdauwera dabcc5d
caught a straggler
vdauwera c4b37e0
prettier fix
vdauwera d75633d
Merge branch 'master' into gvda-hello-nf-core
vdauwera 220e200
note formatting fix
vdauwera edba0a3
Merge branch 'gvda-hello-nf-core' of https://github.com/nextflow-io/t…
vdauwera a8d5142
Improve meta pages (especially next steps)
vdauwera 5a8e113
Add survey page for hello nf-core
vdauwera b08d71f
Improve next steps pages
vdauwera 70cd57c
Add next steps page to Genomics course too
vdauwera fb70c7f
Add logo to index page
vdauwera 788b6d3
formatting fixes
vdauwera bffe780
formatting sub lists...
vdauwera c5ed364
nested lists fix?
vdauwera 50a6843
workaround for nested lists not formatting correctly
vdauwera ea70e94
aaaargh
vdauwera 98cdfa7
alternate attempt to previous
vdauwera 7dd20f7
least objectionable workaround
vdauwera 88213b3
a few more tweaks
vdauwera d62f157
Merge branch 'master' into gvda-hello-nf-core
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
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,73 @@ | ||
# Orientation | ||
|
||
## GitHub Codespaces | ||
|
||
The GitHub Codespaces 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) GitHub 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 go through the [Environment Setup](../../envsetup/) mini-course before going any further. | ||
|
||
!!! warning | ||
|
||
This training is designed for nf-core tools version 3.2.1, which should be the version installed in the codespace. If you use a different version of nf-core tooling you may have difficulty following along. | ||
|
||
You can check what version is installed using the command`nf-core --version`. | ||
|
||
## Working directory | ||
|
||
Throughout this training course, we'll be working in the `hello-nf-core/` directory. | ||
|
||
Change directory now by running this command in the terminal: | ||
|
||
```bash | ||
cd hello-nf-core/ | ||
``` | ||
|
||
!!! tip | ||
|
||
If for whatever reason you move out of this directory, you can always use the full path to return to it, assuming you're running this within the Github Codespaces training environment: | ||
|
||
```bash | ||
cd /workspaces/training/hello-nf-core | ||
``` | ||
|
||
Now let's have a look at the contents of this directory. | ||
|
||
## Materials provided | ||
|
||
You can explore the contents of this directory by using the file explorer on the left-hand side of the training 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. | ||
|
||
Here we generate a table of contents to the second level down: | ||
|
||
```bash | ||
tree . -L 2 | ||
``` | ||
|
||
If you run this inside `hello-nf-core`, you should see the following output: | ||
|
||
```console title="Directory contents" | ||
. | ||
├── greetings.csv | ||
├── original-hello | ||
│ ├── hello.nf | ||
│ ├── modules | ||
│ └── nextflow.config | ||
└── solutions | ||
└── composable-hello | ||
|
||
4 directories, 3 files | ||
``` | ||
|
||
**Here's a summary of what you should know to get started:** | ||
|
||
- **The `greetings.csv` file** is a CSV containing some minimal columnar data we use for testing purposes. | ||
|
||
- **The `original-hello` directory** contains a copy of the source code produced by working through the complete Hello Nextflow training series (with Docker enabled). | ||
|
||
- **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. | ||
|
||
**Now, to begin the course, click on the arrow in the bottom right corner of this page.** |
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.