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

Review and removal of redundancies #72

Merged
merged 15 commits into from
Dec 8, 2023

Conversation

fasterius
Copy link
Contributor

No description provided.

@mahesh-panchal mahesh-panchal self-assigned this Mar 28, 2022
Copy link
Collaborator

@mahesh-panchal mahesh-panchal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the updates, although the copy-paste bit needs to be done from a live coding view. I think it would be beneficial if the first script part was separated into a second episode (and the rest number shifted along)

<br>
<em>Example bioinformatics variant calling workflow/pipeline diagram from nf-core (https://nf-co.re/sarek) and simple RNA-Seq pipeline in DAG format.
</em>
<em> Example bioinformatics variant calling workflow/pipeline diagram from nf-core (https://nf-co.re/sarek) and simple RNA-Seq pipeline in DAG format. </em>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The caption doesn't match the diagram.

_episodes/01-getting-started-with-nextflow.md Outdated Show resolved Hide resolved
1. A `script` block that contains the bash commands ` printf '${read}` to print the name of the read file, and ` gunzip -c ${read} | wc -l` to count the number of lines in the gzipped read file.
We are now going to look at a sample Nextflow script that counts the number of
lines in a file. Create the file `word_count.nf` in the current directory using
your favourite text editor and copy-paste the following code:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be done with the live coding format in mind. No copy and paste. It's preferable to lead them through building up the script.

/* Comments are uninterpreted text included with the script.
They are useful for describing complex parts of the workflow
or providing useful information such as workflow usage.
/*
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's important to keep the information on using comments.
As this is also live coded, I think comments should be kept simple, even though it's visually clearer to have ====== blocks.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe for the example script it doesn't matter, but I guess in practice one would likely just write the comment

_episodes/01-getting-started-with-nextflow.md Outdated Show resolved Hide resolved
@ggrimes ggrimes merged commit 5b45345 into carpentries-incubator:gh-pages Dec 8, 2023
1 check passed
ggrimes added a commit that referenced this pull request Dec 8, 2023
Review and removal of redundancies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants