Skip to content

Commit 52365a4

Browse files
Deployed 740a9be to 0.dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 77229ae commit 52365a4

File tree

90 files changed

+5118
-3894
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+5118
-3894
lines changed

0.dev/es/hello_nf-core/00_orientation/index.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4332,9 +4332,10 @@ <h3 id="check-out-the-materials-provided">Check out the materials provided<a cla
43324332
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="go"> ├── core-hello-part2</span>
43334333
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="go"> ├── core-hello-part3</span>
43344334
<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a><span class="go"> ├── core-hello-part4</span>
4335-
<a id="__codelineno-3-12" name="__codelineno-3-12" href="#__codelineno-3-12"></a><span class="go"> └── core-hello-start</span>
4336-
<a id="__codelineno-3-13" name="__codelineno-3-13" href="#__codelineno-3-13"></a>
4337-
<a id="__codelineno-3-14" name="__codelineno-3-14" href="#__codelineno-3-14"></a><span class="go">8 directories, 3 files</span>
4335+
<a id="__codelineno-3-12" name="__codelineno-3-12" href="#__codelineno-3-12"></a><span class="go"> ├── core-hello-part5</span>
4336+
<a id="__codelineno-3-13" name="__codelineno-3-13" href="#__codelineno-3-13"></a><span class="go"> └── core-hello-start</span>
4337+
<a id="__codelineno-3-14" name="__codelineno-3-14" href="#__codelineno-3-14"></a>
4338+
<a id="__codelineno-3-15" name="__codelineno-3-15" href="#__codelineno-3-15"></a><span class="go">9 directories, 3 files</span>
43384339
</code></pre></div>
43394340
</details>
43404341
<div class="admonition note">

0.dev/es/hello_nf-core/01_run_demo/index.html

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4755,7 +4755,7 @@ <h1 id="part-1-run-a-demo-pipeline">Part 1: Run a demo pipeline<a class="headerl
47554755
<h2 id="1-find-and-retrieve-the-nf-coredemo-pipeline">1. Find and retrieve the nf-core/demo pipeline<a class="headerlink" href="#1-find-and-retrieve-the-nf-coredemo-pipeline" title="Permanent link">&para;</a></h2>
47564756
<p>Let's start by locating the nf-core/demo pipeline on the project website at <a href="https://nf-co.re">nf-co.re</a>, which centralizes all information such as: general documentation and help articles, documentation for each of the pipelines, blog posts, event announcements and so forth.</p>
47574757
<h3 id="11-find-the-pipeline-on-the-website">1.1. Find the pipeline on the website<a class="headerlink" href="#11-find-the-pipeline-on-the-website" title="Permanent link">&para;</a></h3>
4758-
<p>In your web browser, go to https://nf-co.re/pipelines/ and type <code>demo</code> in the search bar.</p>
4758+
<p>In your web browser, go to <a href="https://nf-co.re/pipelines/">https://nf-co.re/pipelines/</a> and type <code>demo</code> in the search bar.</p>
47594759
<p><img alt="search results" src="../../../hello_nf-core/img/search-results.png" /></p>
47604760
<p>Click on the pipeline name, <code>demo</code>, to access the pipeline documentation page.</p>
47614761
<p>Each released pipeline has a dedicated page that includes the following documentation sections:</p>
@@ -4816,6 +4816,8 @@ <h3 id="12-retrieve-the-pipeline-code">1.2. Retrieve the pipeline code<a class="
48164816
<div class="highlight"><span class="filename">Directory contents</span><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="go">/workspaces/.nextflow/assets/</span>
48174817
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="go">└── nf-core</span>
48184818
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="go"> └── demo</span>
4819+
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a>
4820+
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="go">2 directories, 0 files</span>
48194821
</code></pre></div>
48204822
<div class="admonition note">
48214823
<p class="admonition-title">Note</p>
@@ -4832,6 +4834,8 @@ <h3 id="12-retrieve-the-pipeline-code">1.2. Retrieve the pipeline code<a class="
48324834
<div class="highlight"><span class="filename">Directory contents</span><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="go">pipelines</span>
48334835
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="go">└── nf-core</span>
48344836
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="go"> └── demo</span>
4837+
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a>
4838+
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="go">2 directories, 0 files</span>
48354839
</code></pre></div>
48364840
<p>Now we can more easily peek into the source code as needed.</p>
48374841
<p>But first, let's try running our first nf-core pipeline!</p>
@@ -4995,7 +4999,7 @@ <h3 id="22-run-the-pipeline">2.2. Run the pipeline<a class="headerlink" href="#2
49954999
</code></pre></div>
49965000
</details>
49975001
<p>If your output matches that, congratulations! You've just run your first nf-core pipeline.</p>
4998-
<p>You'll notice that there is more a lot more console output than when you run a basic Nextflow pipeline.
5002+
<p>You'll notice that there is a lot more console output than when you run a basic Nextflow pipeline.
49995003
There's a header that includes a summary of the pipeline's version, inputs and outputs, and a few elements of configuration.</p>
50005004
<div class="admonition note">
50015005
<p class="admonition-title">Note</p>
@@ -5148,21 +5152,19 @@ <h4 id="314-the-modules">3.1.4. The modules<a class="headerlink" href="#314-the-
51485152
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="go">pipelines/nf-core/demo/modules</span>
51495153
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="go">└── nf-core</span>
51505154
<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a><span class="go"> ├── fastqc</span>
5151-
<a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="go">   ├── environment.yml</span>
5152-
<a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a><span class="go">   ├── main.nf</span>
5153-
<a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a><span class="go">   ├── meta.yml</span>
5154-
<a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a><span class="go">   └── tests</span>
5155+
<a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="go"> ├── environment.yml</span>
5156+
<a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a><span class="go"> ├── main.nf</span>
5157+
<a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a><span class="go"> ├── meta.yml</span>
5158+
<a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a><span class="go"> └── tests</span>
51555159
<a id="__codelineno-21-8" name="__codelineno-21-8" href="#__codelineno-21-8"></a><span class="go"> ├── multiqc</span>
5156-
<a id="__codelineno-21-9" name="__codelineno-21-9" href="#__codelineno-21-9"></a><span class="go">   ├── environment.yml</span>
5157-
<a id="__codelineno-21-10" name="__codelineno-21-10" href="#__codelineno-21-10"></a><span class="go">   ├── main.nf</span>
5158-
<a id="__codelineno-21-11" name="__codelineno-21-11" href="#__codelineno-21-11"></a><span class="go">   ├── meta.yml</span>
5159-
<a id="__codelineno-21-12" name="__codelineno-21-12" href="#__codelineno-21-12"></a><span class="go">   └── tests</span>
5160+
<a id="__codelineno-21-9" name="__codelineno-21-9" href="#__codelineno-21-9"></a><span class="go"> ├── environment.yml</span>
5161+
<a id="__codelineno-21-10" name="__codelineno-21-10" href="#__codelineno-21-10"></a><span class="go"> ├── main.nf</span>
5162+
<a id="__codelineno-21-11" name="__codelineno-21-11" href="#__codelineno-21-11"></a><span class="go"> ├── meta.yml</span>
5163+
<a id="__codelineno-21-12" name="__codelineno-21-12" href="#__codelineno-21-12"></a><span class="go"> └── tests</span>
51605164
<a id="__codelineno-21-13" name="__codelineno-21-13" href="#__codelineno-21-13"></a><span class="go"> └── seqtk</span>
51615165
<a id="__codelineno-21-14" name="__codelineno-21-14" href="#__codelineno-21-14"></a><span class="go"> └── trim</span>
5162-
<a id="__codelineno-21-15" name="__codelineno-21-15" href="#__codelineno-21-15"></a><span class="go"> ├── environment.yml</span>
5163-
<a id="__codelineno-21-16" name="__codelineno-21-16" href="#__codelineno-21-16"></a><span class="go"> ├── main.nf</span>
5164-
<a id="__codelineno-21-17" name="__codelineno-21-17" href="#__codelineno-21-17"></a><span class="go"> ├── meta.yml</span>
5165-
<a id="__codelineno-21-18" name="__codelineno-21-18" href="#__codelineno-21-18"></a><span class="go"> └── tests</span>
5166+
<a id="__codelineno-21-15" name="__codelineno-21-15" href="#__codelineno-21-15"></a>
5167+
<a id="__codelineno-21-16" name="__codelineno-21-16" href="#__codelineno-21-16"></a><span class="go">7 directories, 6 files</span>
51665168
</code></pre></div>
51675169
</details>
51685170
<p>Here you see that the <code>fastqc</code> and <code>multiqc</code> modules sit at the top level within the <code>nf-core</code> modules, whereas the <code>trim</code> module sits under the toolkit that it belongs to, <code>seqtk</code>.
@@ -5193,6 +5195,8 @@ <h4 id="315-the-housekeeping-subworkflows">3.1.5. The housekeeping subworkflows<
51935195
<a id="__codelineno-23-15" name="__codelineno-23-15" href="#__codelineno-23-15"></a><span class="go"> ├── main.nf</span>
51945196
<a id="__codelineno-23-16" name="__codelineno-23-16" href="#__codelineno-23-16"></a><span class="go"> ├── meta.yml</span>
51955197
<a id="__codelineno-23-17" name="__codelineno-23-17" href="#__codelineno-23-17"></a><span class="go"> └── tests</span>
5198+
<a id="__codelineno-23-18" name="__codelineno-23-18" href="#__codelineno-23-18"></a>
5199+
<a id="__codelineno-23-19" name="__codelineno-23-19" href="#__codelineno-23-19"></a><span class="go">9 directories, 7 files</span>
51965200
</code></pre></div>
51975201
</details>
51985202
<p>As noted above, the <code>nf-core/demo</code> pipeline does not include any analysis-specific subworkflows, so all the subworkflows we see here are so-called 'housekeeping' or 'utility' workflows, as denoted by the <code>utils_</code> prefix in their names.
@@ -5245,7 +5249,7 @@ <h3 id="whats-next_2">What's next?<a class="headerlink" href="#whats-next_2" tit
52455249
<p>Take a break! That was a lot. When you're feeling refreshed and ready, move on to the next section to apply what you've learned to write an nf-core compatible pipeline.</p>
52465250
<div class="admonition tip">
52475251
<p class="admonition-title">Tip</p>
5248-
<p>If you would like to learn how to compose workflows with subworkflows before moving on to the next part, check out the <a href="../side_quests/workflows_of_workflows/">Workflows of Workflows</a> Side Quest.</p>
5252+
<p>If you would like to learn how to compose workflows with subworkflows before moving on to the next part, check out the <a href="../../side_quests/workflows_of_workflows/">Workflows of Workflows</a> Side Quest.</p>
52495253
</div>
52505254

52515255

0 commit comments

Comments
 (0)