Skip to content

Commit

Permalink
Deployed d40c8b0 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
nwiltsie committed Oct 25, 2024
1 parent 5fb6b70 commit 43a493d
Show file tree
Hide file tree
Showing 13 changed files with 25 additions and 25 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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
2 changes: 1 addition & 1 deletion development/discussions/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">Discussions</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
6 changes: 3 additions & 3 deletions development/how-to-run/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">How To Run</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand All @@ -111,10 +111,10 @@ <h2 id="how-to-run">How To Run</h2>
<p><strong>The pipeline is currently configured to run on a SINGLE NODE mode with normal only, tumor only, normal-tumor paired, or multiple normal and tumor samples.</strong></p>
<ol>
<li>
<p>Update the params section of the .config file (<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/config/template.config">Example config</a>).</p>
<p>Update the params section of the .config file (<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/config/template.config">Example config</a>).</p>
</li>
<li>
<p>Update the YAML (<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/input">Template YAMLs</a>).</p>
<p>Update the YAML (<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/input">Template YAMLs</a>).</p>
</li>
<li>
<p>Download the submission script (submit_nextflow_pipeline.py) from <a href="https://github.com/uclahs-cds/tool-submit-nf">here</a>, and submit your pipeline below.</p>
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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down Expand Up @@ -170,5 +170,5 @@ <h1 id="recalibrate-bam">recalibrate-BAM</h1>

<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-10-09 00:13:59.773947+00:00
Build Date UTC : 2024-10-25 23:46:12.261120+00:00
-->
16 changes: 8 additions & 8 deletions development/inputs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down Expand Up @@ -262,31 +262,31 @@ <h3 id="config">Config</h3>
<td style="text-align: left;"><code>reference_fasta</code></td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">path</td>
<td style="text-align: left;">Absolute path to reference genome fasta file, e.g., <code>/hot/ref/reference/GRCh38-BI-20160721/Homo_sapiens_assembly38.fasta</code></td>
<td style="text-align: left;">Absolute path to reference genome fasta file, e.g., <code>/hot/resource/reference-genome/GRCh38-BI-20160721/Homo_sapiens_assembly38.fasta</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>bundle_mills_and_1000g_gold_standard_indels_vcf_gz</code></td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">path</td>
<td style="text-align: left;">Absolute path to Mills &amp; 1000G Gold Standard Indels file, e.g., <code>/hot/ref/tool-specific-input/GATK/GRCh38/Mills_and_1000G_gold_standard.indels.hg38.vcf.gz</code></td>
<td style="text-align: left;">Absolute path to Mills &amp; 1000G Gold Standard Indels file, e.g., <code>/hot/resource/tool-specific-input/GATK/GRCh38/Mills_and_1000G_gold_standard.indels.hg38.vcf.gz</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>bundle_known_indels_vcf_gz</code></td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">path</td>
<td style="text-align: left;">Absolute path to known indels file, e.g., <code>/hot/ref/tool-specific-input/GATK/GRCh38/Homo_sapiens_assembly38.known_indels.vcf.gz</code></td>
<td style="text-align: left;">Absolute path to known indels file, e.g., <code>/hot/resource/tool-specific-input/GATK/GRCh38/Homo_sapiens_assembly38.known_indels.vcf.gz</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>bundle_v0_dbsnp138_vcf_gz</code></td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">path</td>
<td style="text-align: left;">Absolute path to dbsnp file, e.g., <code>/hot/ref/tool-specific-input/GATK/GRCh38/resources_broad_hg38_v0_Homo_sapiens_assembly38.dbsnp138.vcf.gz</code></td>
<td style="text-align: left;">Absolute path to dbsnp file, e.g., <code>/hot/resource/tool-specific-input/GATK/GRCh38/resources_broad_hg38_v0_Homo_sapiens_assembly38.dbsnp138.vcf.gz</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>bundle_contest_hapmap_3p3_vcf_gz</code></td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">path</td>
<td style="text-align: left;">Absolute path to HapMap 3.3 biallelic sites file, e.g., <code>/hot/ref/tool-specific-input/GATK/GRCh38/Biallelic/hapmap_3.3.hg38.BIALLELIC.PASS.2021-09-01.vcf.gz</code></td>
<td style="text-align: left;">Absolute path to HapMap 3.3 biallelic sites file, e.g., <code>/hot/resource/tool-specific-input/GATK/GRCh38/Biallelic/hapmap_3.3.hg38.BIALLELIC.PASS.2021-09-01.vcf.gz</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>work_dir</code></td>
Expand All @@ -302,7 +302,7 @@ <h3 id="config">Config</h3>
</tr>
</tbody>
</table>
<p>The below parameters have default values defined in <a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/config/default.config"><code>default.config</code></a> and generally do not need to be set by the user.</p>
<p>The below parameters have default values defined in <a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/config/default.config"><code>default.config</code></a> and generally do not need to be set by the user.</p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -395,7 +395,7 @@ <h3 id="config">Config</h3>
</tbody>
</table>
<h4 id="base-resource-allocation-updaters">Base resource allocation updaters</h4>
<p>To update the base resource (cpus or memory) allocations for processes, use the following structure and add the necessary parts. The default allocations can be found in the <a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/config">node-specific config files</a></p>
<p>To update the base resource (cpus or memory) allocations for processes, use the following structure and add the necessary parts. The default allocations can be found in the <a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/config">node-specific config files</a></p>
<pre><code class="language-Nextflow">base_resource_update {
memory = [
[['process_name', 'process_name2'], &lt;multiplier for resource&gt;],
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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
2 changes: 1 addition & 1 deletion development/overview/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">Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down
2 changes: 1 addition & 1 deletion development/pipeline-steps/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/README.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
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-recalibrate-BAM/blob/7aaae3466345f0287d1cb5980a268d55dac24ec1/README.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/uclahs-cds/pipeline-recalibrate-BAM/blob/d40c8b0316fb2c30dd1cba37dc09eee0fbce782c/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.
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": "7aaae3466345f0287d1cb5980a268d55dac24ec1",
"date": "2024-10-08T17:12:38-07:00"
"commit": "d40c8b0316fb2c30dd1cba37dc09eee0fbce782c",
"date": "2024-10-25T16:45:37-07:00"
}
},
{
"version": "v1.0.2",
"title": "v1.0.2",
"aliases": [
"latest",
"release-candidate"
"release-candidate",
"latest"
],
"properties": {
"commit": "7aaae3466345f0287d1cb5980a268d55dac24ec1",
Expand Down

0 comments on commit 43a493d

Please sign in to comment.