{
- "name": "Tutorial align using bwa mem and SortSam",
- "components": {
- "bwa-mem": {
- "script": "run-command",
- "script_version": "master",
- "repository": "arvados",
- "script_parameters": {
- "command": [
- "bwa",
- "mem",
- "-t",
- "$(node.cores)",
- "-R",
- "@RG\\tID:group_id\\tPL:illumina\\tSM:sample_id",
- "$(glob $(dir $(reference_collection))/*.fasta)",
- "$(glob $(dir $(sample))/*_1.fastq)",
- "$(glob $(dir $(sample))/*_2.fastq)"
- ],
- "reference_collection": {
- "required": true,
- "dataclass": "Collection"
+ "name": "Tutorial align using bwa mem and SortSam",
+ "components": {
+ "bwa-mem": {
+ "script": "run-command",
+ "script_version": "master",
+ "repository": "arvados",
+ "script_parameters": {
+ "command": [
+ "bwa",
+ "mem",
+ "-t",
+ "$(node.cores)",
+ "-R",
+ "@RG\\tID:group_id\\tPL:illumina\\tSM:sample_id",
+ "$(glob $(dir $(reference_collection))/*.fasta)",
+ "$(glob $(dir $(sample))/*_1.fastq)",
+ "$(glob $(dir $(sample))/*_2.fastq)"
+ ],
+ "reference_collection": {
+ "required": true,
+ "dataclass": "Collection"
+ },
+ "sample": {
+ "required": true,
+ "dataclass": "Collection"
+ },
+ "stdout": "$(basename $(glob $(dir $(sample))/*_1.fastq)).sam"
+ },
+ "runtime_constraints": {
+ "docker_image": "arvados/jobs-java-bwa-samtools"
+ }
},
- "sample": {
- "required": true,
- "dataclass": "Collection"
- },
- "stdout": "$(basename $(glob $(dir $(sample))/*_1.fastq)).sam"
- },
- "runtime_constraints": {
- "docker_image": "arvados/jobs-java-bwa-samtools"
- }
- }
- },
- "SortSam": {
- "script": "run-command",
- "script_version": "847459b3c257aba65df3e0cbf6777f7148542af2",
- "repository": "arvados",
- "script_parameters": {
- "command": [
- "java",
- "-Xmx4g",
- "-Djava.io.tmpdir=$(tmpdir)",
- "-jar",
- "$(dir $(picard))/SortSam.jar",
- "CREATE_INDEX=True",
- "SORT_ORDER=coordinate",
- "VALIDATION_STRINGENCY=LENIENT",
- "INPUT=$(glob $(dir $(input))/*.sam)",
- "OUTPUT=$(basename $(glob $(dir $(input))/*.sam)).sort.bam"
- ],
- "input": {
- "output_of": "bwa-mem"
- },
- "picard": {
- "required": true,
- "dataclass": "Collection",
- "default": "88447c464574ad7f79e551070043f9a9+1970"
+ "SortSam": {
+ "script": "run-command",
+ "script_version": "847459b3c257aba65df3e0cbf6777f7148542af2",
+ "repository": "arvados",
+ "script_parameters": {
+ "command": [
+ "java",
+ "-Xmx4g",
+ "-Djava.io.tmpdir=$(tmpdir)",
+ "-jar",
+ "$(dir $(picard))/SortSam.jar",
+ "CREATE_INDEX=True",
+ "SORT_ORDER=coordinate",
+ "VALIDATION_STRINGENCY=LENIENT",
+ "INPUT=$(glob $(dir $(input))/*.sam)",
+ "OUTPUT=$(basename $(glob $(dir $(input))/*.sam)).sort.bam"
+ ],
+ "input": {
+ "output_of": "bwa-mem"
+ },
+ "picard": {
+ "required": true,
+ "dataclass": "Collection",
+ "default": "88447c464574ad7f79e551070043f9a9+1970"
+ }
+ },
+ "runtime_constraints": {
+ "docker_image": "arvados/jobs-java-bwa-samtools"
+ }
}
- },
- "runtime_constraints": {
- "docker_image": "arvados/jobs-java-bwa-samtools"
- }
}
-}
\ No newline at end of file
+}
{% include 'tutorial_expectations' %}
-Use the following command to create a new empty template using @arv pipeline_template create@, then open the template record in an interactive text editor (as specified by $EDITOR or $VISUAL, otherwise defaults to @nano@) using @arv edit@.
+Use the following command to create a new empty template using @arv pipeline_template create@:
<notextile>
<pre><code>~$ <span class="userinput">arv edit $(arv --format=uuid pipeline_template create --pipeline-template '{}') name components </span></code></pre>
* @--format=uuid@ option prints out just the unique identifier for the new template, instead of the entire template record (default)
-Next, in the text editor opened by @arv edit@ replace the empty fields with the following content:
+This will open the template record in an interactive text editor (as specified by $EDITOR or $VISUAL, otherwise defaults to @nano@) using @arv edit@. Now add the following content:
<notextile>{% code 'tutorial_bwa_sortsam_pipeline' as javascript %}</notextile>
h2. Running your pipeline
-Your new pipeline template should appear at the top of the Workbench "pipeline templates":https://{{ site.arvados_workbench_host }}/pipeline_templates page. You can run your pipeline "using Workbench":tutorial-pipeline-workbench.html or the "command line.":{{site.baseurl}}/user/topics/running-pipeline-command-line.html
+Your new pipeline template should appear at the top of the Workbench "pipeline templates":https://{{ site.arvados_workbench_host }}/pipeline_templates page. You can run your pipeline "using Workbench":tutorial-pipeline-workbench.html or the "command line.":{{site.baseurl}}/user/topics/running-pipeline-command-line.html Test data is available in the "Arvados Tutorial":https://{{ site.arvados_workbench_host }}/projects/qr1hi-j7d0g-u7zg1qdaowykd8d project.
For more information and examples for writing pipelines, see the "pipeline template reference":{{site.baseurl}}/api/schema/PipelineTemplate.html