Skip to content

Commit

Permalink
Deployed 4d89cd3 to development with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Faizal-Eeman committed May 20, 2024
1 parent d8e02b3 commit 9f69244
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion development/contributors/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Contributors</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
2 changes: 1 addition & 1 deletion development/flow-diagram/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Flow Diagram</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
10 changes: 5 additions & 5 deletions development/how-to-run/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">How To Run</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand All @@ -124,13 +124,13 @@ <h3 id="run-steps">Run steps</h3>
<p>The source code should never be modified when running our pipelines</p>
</li>
<li>
<p>Create a config file for input, output, and parameters. An example for a config file can be found <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/config/template.config">here</a>. See <a href="../inputs/#Nextflow-Config-File-Parameters">Nextflow Config File Parameters</a> for the detailed description of each variable in the config file.</p>
<p>Create a config file for input, output, and parameters. An example for a config file can be found <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/config/template.config">here</a>. See <a href="../inputs/#Nextflow-Config-File-Parameters">Nextflow Config File Parameters</a> for the detailed description of each variable in the config file.</p>
</li>
<li>
<p>Do not directly modify the source <code>template.config</code>, but rather you should copy it from the pipeline release folder to your project-specific folder and modify it there</p>
</li>
<li>
<p>Create the input YAML using the <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/input/call-gSV-input.yaml">template</a>. See <a href="../inputs/#Input-YAML">Input YAML</a> for a detailed description.</p>
<p>Create the input YAML using the <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/input/call-gSV-input.yaml">template</a>. See <a href="../inputs/#Input-YAML">Input YAML</a> for a detailed description.</p>
</li>
<li>
<p>Again, do not directly modify the source template YAML file. Instead, copy it from the pipeline release folder to your project-specific folder and modify it there.</p>
Expand All @@ -143,8 +143,8 @@ <h3 id="run-steps">Run steps</h3>
</code></pre>
<ul>
<li>For example, <code>path/to/main.nf</code> could be: <code>/hot/software/pipeline/pipeline-call-gSV/Nextflow/release/5.0.0-rc.1/main.nf</code></li>
<li><code>path/to/sample-specific.config</code> is the path to where you saved your project-specific copy of <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/config/template.config">template.config</a></li>
<li><code>path/to/input.yaml</code> is the path to where you saved your sample-specific copy of <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/input/call-gSV-input.yaml">call-gSV-input.yaml</a></li>
<li><code>path/to/sample-specific.config</code> is the path to where you saved your project-specific copy of <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/config/template.config">template.config</a></li>
<li><code>path/to/input.yaml</code> is the path to where you saved your sample-specific copy of <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/input/call-gSV-input.yaml">call-gSV-input.yaml</a></li>
</ul>
<p>To submit to UCLAHS-CDS's Azure cloud, use the submission script <a href="https://github.com/uclahs-cds/tool-submit-nf">here</a> with the command below:</p>
<pre><code class="language-bash">python path/to/submit_nextflow_pipeline.py \
Expand Down
4 changes: 2 additions & 2 deletions development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down Expand Up @@ -186,5 +186,5 @@ <h1 id="call-gsv">call-gSV</h1>

<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-05-20 21:44:35.070853+00:00
Build Date UTC : 2024-05-20 23:49:39.335605+00:00
-->
4 changes: 2 additions & 2 deletions development/inputs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Inputs</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down Expand Up @@ -257,7 +257,7 @@ <h3 id="nextflow-config-file-parameters">Nextflow Config File Parameters</h3>
</tr>
</tbody>
</table>
<p>An example of the NextFlow Input Parameters Config file can be found <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/config/template.config">here</a>.</p>
<p>An example of the NextFlow Input Parameters Config file can be found <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/config/template.config">here</a>.</p>
<hr />

</div>
Expand Down
2 changes: 1 addition & 1 deletion development/license/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">License</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
2 changes: 1 addition & 1 deletion development/outputs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Outputs</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
4 changes: 2 additions & 2 deletions development/overview/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down Expand Up @@ -153,7 +153,7 @@ <h3 id="node-specific-config-file-settings">Node Specific Config File Settings</
</tbody>
</table>
<hr />
<p>* Manta SV calling wouldn't work on an F2 node due to incompatible resources. In order to test the pipeline for tasks not relevant to Manta, please set <code>run_manta = false</code> in the sample specific <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/config/template.config">config</a> file.</p>
<p>* Manta SV calling wouldn't work on an F2 node due to incompatible resources. In order to test the pipeline for tasks not relevant to Manta, please set <code>run_manta = false</code> in the sample specific <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/config/template.config">config</a> file.</p>

</div>
</div><footer>
Expand Down
4 changes: 2 additions & 2 deletions development/pipeline-steps/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Pipeline Steps</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down Expand Up @@ -196,7 +196,7 @@ <h3 id="1-calling-structural-variants">1. Calling Structural Variants</h3>
</table>
<h3 id="2-calling-copy-number-variants">2. Calling Copy Number Variants</h3>
<p>The second step of the pipeline identifies CNVs. To do this, Delly requires an aligned and sorted BAM file, as well as the BCF output from the SV calling step (to refine breakpoints) and a mappability map. Any CNVs identified are annotated and output as a single BCF file.</p>
<p>Currently the following filters are applied by Delly when calling CNVs. Parameters with a "call-gSV default" can be updated in the sample specific nextflow <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/config/template.config">config</a> file.
<p>Currently the following filters are applied by Delly when calling CNVs. Parameters with a "call-gSV default" can be updated in the sample specific nextflow <a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/config/template.config">config</a> file.
<br></p>
<table>
<thead>
Expand Down
2 changes: 1 addition & 1 deletion development/references/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">References</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
Binary file modified development/sitemap.xml.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion development/testing-and-validation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Testing and Validation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/ab0a099f4da29314691b7cb6a0c819ab8812a4ce/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-call-gSV/blob/4d89cd3b227b913a482154f9d631698e6fcfed9d/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
8 changes: 4 additions & 4 deletions versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
"title": "development",
"aliases": [],
"properties": {
"commit": "ab0a099f4da29314691b7cb6a0c819ab8812a4ce",
"date": "2024-05-20T14:43:59-07:00"
"commit": "4d89cd3b227b913a482154f9d631698e6fcfed9d",
"date": "2024-05-20T16:49:00-07:00"
}
},
{
"version": "v5.0.0",
"title": "v5.0.0",
"aliases": [
"latest",
"release-candidate"
"release-candidate",
"latest"
],
"properties": {
"commit": "1111cac0e0dbe4b6a2dd1bdbba9e5ebe7688955f",
Expand Down

0 comments on commit 9f69244

Please sign in to comment.