Repository revision
33:3f254c5ced1d

Repository 'picard'
hg clone https://toolshed.g2.bx.psu.edu/repos/devteam/picard

MergeBamAlignment tool metadata
Miscellaneous
merge alignment data with additional info stored in an unmapped BAM dataset
picard_MergeBamAlignment
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/3.1.1.0
3.1.1.0
None
True
Version lineage of this tool (guids ordered most recent to oldest)
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/3.1.1.0 (this tool)
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/2.18.2.2
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/2.18.2.1
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/2.18.2.0
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/2.7.1.0
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/1.136.0
toolshed.g2.bx.psu.edu/repos/devteam/picard/picard_MergeBamAlignment/1.126.0
picard_MergeBamAlignment
Requirements (dependencies defined in the <requirements> tag set)
name version type
picard 3.1.1 package
Additional information about this tool
_JAVA_OPTIONS=\${_JAVA_OPTIONS:-"-Xmx2048m -Xms256m -Djava.io.tmpdir=\${TMPDIR:-\${_GALAXY_JOB_TMPDIR}}"} &&
    export _JAVA_OPTIONS &&
    
    #set $picard_dict = "localref.dict"
    #set $ref_fasta = "localref.fa"     ## This is done because picards "likes" .fa extension

    ln -sf '${reference_source.ref_file}' '${ref_fasta}' &&

    #if str( $reference_source.reference_source_selector ) == "history":

      picard CreateSequenceDictionary
      -REFERENCE '${ref_fasta}'
      -OUTPUT '${picard_dict}'
      -QUIET true
      -VERBOSITY ERROR

      &&

    #else:

      #set $ref_fasta = str( $reference_source.ref_file.fields.path )

    #end if

    picard MergeBamAlignment
      --UNMAPPED_BAM '${unmapped_bam}'

      --PAIRED_RUN true ##This argument is ignored and will be removed. Required. Possible values: {true, false}

      #if str( $aligned_or_read1_and_read2.aligned_or_read1_and_read2_selector ) == "paired_one_file":
        #for $dataset in $aligned_or_read1_and_read2.aligned_bams:
            --ALIGNED_BAM '${dataset.aligned_bam}'
        #end for
      #elif str( $aligned_or_read1_and_read2.aligned_or_read1_and_read2_selector ) == "paired_two_files":
        #for $dataset in $aligned_or_read1_and_read2.read1_aligned_bams:
            --READ1_ALIGNED_BAM '${dataset.read1_aligned_bam}'
        #end for
        #for $dataset in $aligned_or_read1_and_read2.read2_aligned_bams:
            --READ2_ALIGNED_BAM '${dataset.read2_aligned_bam}'
        #end for
      #else
        #for $dataset in $aligned_or_read1_and_read2.read1_aligned_bams:
            --READ1_ALIGNED_BAM '${dataset.read1_aligned_bam}'
        #end for
      #end if

      --OUTPUT '${outFile}'
      --REFERENCE_SEQUENCE '${ref_fasta}'

      --CLIP_ADAPTERS '${clip_adapters}'
      --IS_BISULFITE_SEQUENCE '${is_bisulfite_sequence}'
      --ALIGNED_READS_ONLY '${aligned_reads_only}'
      --MAX_INSERTIONS_OR_DELETIONS '${max_insertions_or_deletions}'

      #for $attribute in $attributes_to_retain:
        --ATTRIBUTES_TO_RETAIN '${$attribute.attribute}'
      #end for

      #for $attribute in $attributes_to_remove:
        --ATTRIBUTES_TO_REMOVE '${$attribute.attribute}'
      #end for

      --READ1_TRIM '${read1_trim}'
      --READ2_TRIM '${read2_trim}'

      #if str( $orientations ) != "None":
        #for $orientation in str( $orientations ).split(','):   ## See trello card https://trello.com/c/9nW02Zhd
          --EXPECTED_ORIENTATIONS '${orientation}'
        #end for
      #end if

      --ALIGNER_PROPER_PAIR_FLAGS '${aligner_proper_pair_flags}'
      --PRIMARY_ALIGNMENT_STRATEGY '${primary_alignment_strategy}'
      --CLIP_OVERLAPPING_READS '${clip_overlapping_reads}'
      --INCLUDE_SECONDARY_ALIGNMENTS '${include_secondary_alignments}'
      --ADD_MATE_CIGAR '${add_mate_cigar}'

      --VALIDATION_STRINGENCY '${validation_stringency}'

      --SORT_ORDER coordinate
      --QUIET true
      --VERBOSITY ERROR

  
None
False
Functional tests
name inputs outputs required files
Test-1 reference_source|ref_file: picard_MergeBamAlignment_ref.fa
reference_source|reference_source_selector: history
unmapped_bam: picard_MergeBamAlignment_unaligned.bam
aligned_or_read1_and_read2|aligned_bams_0|aligned_bam: picard_MergeBamAlignment_aligned.bam
aligned_or_read1_and_read2|aligned_or_read1_and_read2_selector: paired_one_file
clip_adapters: True
is_bisulfite_sequence: False
aligned_reads_only: False
max_insertions_or_deletions: 1
read1_trim: 0
read2_trim: 0
orientations: FR
aligner_proper_pair_flags: False
primary_alignment_strategy: BestMapq
clip_overlapping_reads: True
include_secondary_alignments: True
add_mate_cigar: True
name: value
picard_MergeBamAlignment_ref.fa
picard_MergeBamAlignment_unaligned.bam
picard_MergeBamAlignment_aligned.bam
value