# HG changeset patch # User devteam # Date 1391303994 18000 # Node ID f7ebcc9dfb867489c245f8504f671e8a26ed0fa9 # Parent 70b3d18820494923b461eb05ecc5e0e999efef42 Deleted selected files diff -r 70b3d1882049 -r f7ebcc9dfb86 picard_ReorderSam.xml --- a/picard_ReorderSam.xml Wed Jan 29 15:52:38 2014 -0500 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,166 +0,0 @@ - - picard - - picard_wrapper.py - --input="${inputFile}" - #if $source.indexSource == "built-in" - --ref="${source.ref.fields.path}" - #else - --ref-file="${refFile}" - --species-name="${source.speciesName}" - --build-name="${source.buildName}" - --trunc-names="${source.truncateSeqNames}" - #end if - --allow-inc-dict-concord="${allowIncDictConcord}" - --allow-contig-len-discord="${allowContigLenDiscord}" - --output-format="${outputFormat}" - --output="${outFile}" - --tmpdir "${__new_file_path__}" - -j "\$JAVA_JAR_PATH/ReorderSam.jar" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -.. class:: infomark - -**Purpose** - -Reorder SAM/BAM to match contig ordering in a particular reference file. Note that this is -not the same as sorting as done by the SortSam tool, which sorts by either coordinate -values or query name. The ordering in ReorderSam is based on exact name matching of -contigs/chromosomes. Reads that are mapped to a contig that is not in the new reference file are -not included in the output. - -**Picard documentation** - -This is a Galaxy wrapper for ReorderSam, a part of the external package Picard-tools_. - - .. _Picard-tools: http://www.google.com/search?q=picard+samtools - ------- - -.. class:: infomark - -**Inputs, outputs, and parameters** - -For the file that needs to be reordered, either a sam file or a bam file must be supplied. -If a bam file is used, it must be coordinate-sorted. A reference file is also required, -so either a fasta file should be supplied or a built-in reference can be selected. - -The output contains the same reads as the input file but the reads have been rearranged so -they appear in the same order as the provided reference file. The tool will output either -bam (the default) or sam, according to user selection. Bam is recommended since it is smaller. - -The only extra parameters that can be set are flags for allowing incomplete dict concordance -and allowing contig length discordance. If incomplete dict concordance is allowed, only a -partial overlap of the bam contigs with the new reference sequence contigs is required. By -default it is off, requiring a corresponding contig in the new reference for each read contig. -If contig length discordance is allowed, contig names that are the same between a read and the -new reference contig are allowed even if they have different lengths. This is usually not a -good idea, unless you know exactly what you're doing. It's off by default. - -.. class:: warningmark - -**Warning on SAM/BAM quality** - -Many SAM/BAM files produced externally and uploaded to Galaxy do not fully conform to SAM/BAM specifications. Galaxy deals with this by using the **LENIENT** -flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears -to be the only way to deal with SAM/BAM that cannot be parsed. - - - - - - - - - - - - - - - - diff -r 70b3d1882049 -r f7ebcc9dfb86 picard_ReplaceSamHeader.xml --- a/picard_ReplaceSamHeader.xml Wed Jan 29 15:52:38 2014 -0500 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,115 +0,0 @@ - - picard - - picard_wrapper.py - --input "${inputFile}" - -o "${outFile}" - --header-file "${headerFile}" - --output-format "${outputFormat}" - -j "\$JAVA_JAR_PATH/ReplaceSamHeader.jar" - --tmpdir "${__new_file_path__}" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -.. class:: infomark - -**Purpose** - -Replace Sam Header with the header from another sam file. The tool does not do any -significant validation, so it's up to the user to make sure that the elements in -the header are relevant and that the new header has all the required things. - -Replace the SAMFileHeader in a SAM file with the given header. Validation is -minimal. It is up to the user to ensure that all the elements referred to in the -SAMRecords are present in the new header. Sort order of the two input files must -be the same. - -**Picard documentation** - -This is a Galaxy wrapper for ReplaceSamHeader, a part of the external package Picard-tools_. - - .. _Picard-tools: http://www.google.com/search?q=picard+samtools - ------- - -.. class:: infomark - -**Inputs and outputs** - -Either a sam file or a bam file is required as the file whose header will be replaced. -The header file is also required and can also be either sam or bam (it does not have -to be the same type as the other file). In both cases, if a bam file is used, it must -be coordinate-sorted. Galaxy currently coordinate-sorts all bam files. - -The tool will output either bam (the default) or sam. Bam is recommended since it is smaller. - -.. class:: warningmark - -**Warning on SAM/BAM quality** - -Many SAM/BAM files produced externally and uploaded to Galaxy do not fully conform to SAM/BAM specifications. Galaxy deals with this by using the **LENIENT** -flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears -to be the only way to deal with SAM/BAM that cannot be parsed. - - - - - - - - - - - - - - - - - diff -r 70b3d1882049 -r f7ebcc9dfb86 picard_SamToFastq.xml --- a/picard_SamToFastq.xml Wed Jan 29 15:52:38 2014 -0500 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,189 +0,0 @@ - - creates a FASTQ file - picard - - picard_SamToFastq_wrapper.py - -p ' - java -XX:DefaultMaxRAMFraction=1 -XX:+UseParallelGC - -jar "\$JAVA_JAR_PATH/SamToFastq.jar" - INPUT="${input_sam}" - VALIDATION_STRINGENCY="LENIENT" - RE_REVERSE="${re_reverse}" - INCLUDE_NON_PF_READS="${include_non_pf_reads}" - #if str( $clipping_attribute ): - CLIPPING_ATTRIBUTE="${clipping_attribute}" - #end if - #if str( $clipping_action ): - CLIPPING_ACTION="${clipping_action}" - #end if - #if str( $read1_trim ): - READ1_TRIM="${read1_trim}" - #end if - #if str( $read1_max_bases_to_write ): - READ1_MAX_BASES_TO_WRITE="${read1_max_bases_to_write}" - #end if - INCLUDE_NON_PRIMARY_ALIGNMENTS="${include_non_primary_alignments}" - - #if str( $output_per_read_group_selector ) == 'per_sam_file': - ##OUTPUT_PER_RG=false - FASTQ="${output_fastq1}" - - #if str( $single_paired_end_type.single_paired_end_type_selector ) == 'paired': - SECOND_END_FASTQ="${output_fastq2}" - #if str( $single_paired_end_type.read2_trim ): - READ2_TRIM="${single_paired_end_type.read2_trim}" - #end if - #if str( $single_paired_end_type.read2_max_bases_to_write ): - READ2_MAX_BASES_TO_WRITE="${single_paired_end_type.read2_max_bases_to_write}" - #end if - #end if - ' - #else: - OUTPUT_PER_RG=true - #if str( $single_paired_end_type.single_paired_end_type_selector ) == 'paired': - ' - --read_group_file_2 "${output_fastq2}" - --file_id_2 "${output_fastq2.id}" - -p ' - #if str( $single_paired_end_type.read2_trim ): - READ2_TRIM="${single_paired_end_type.read2_trim}" - #end if - #if str( $single_paired_end_type.read2_max_bases_to_write ): - READ2_MAX_BASES_TO_WRITE="${single_paired_end_type.read2_max_bases_to_write}" - #end if - #end if - ' - --read_group_file_1 "${output_fastq1}" - --new_files_path "${__new_file_path__}" - --file_id_1 "${output_fastq1.id}" - #end if - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - single_paired_end_type['single_paired_end_type_selector'] == 'paired' - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -**What it does** - -Picard: SamToFastq converts SAM files to FASTQ files. - -Extracts read sequences and qualities from the input SAM/BAM file and writes them into the output file in Sanger fastq format. In the RC mode (default is True), if the read is aligned and the alignment is to the reverse strand on the genome, the read's sequence from input SAM file will be reverse-complemented prior to writing it to fastq in order restore correctly the original read sequence as it was generated by the sequencer. - ------- - -Please cite the website "http://picard.sourceforge.net". - ------- - - -**Input formats** - -FastqToSam accepts SAM input files, see http://samtools.sourceforge.net for more details. - ------- - -**Outputs** - -The output is in FASTQ format. If using Paired end data, 2 fastq files are created. - -------- - -**FastqToSam settings** - -This is list of SamToFastq options:: - - INPUT=File Input SAM/BAM file to extract reads from Required. - FASTQ=File Output fastq file (single-end fastq or, if paired, first end of the pair fastq). Required. Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG) - SECOND_END_FASTQ=File Output fastq file (if paired, second end of the pair fastq). Default value: null. Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG) - OUTPUT_PER_RG=Boolean Output a fastq file per read group (two fastq files per read group if the group is paired). Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false} Cannot be used in conjuction with option(s) SECOND_END_FASTQ (F2) FASTQ (F) - OUTPUT_DIR=File Directory in which to output the fastq file(s). Used only when OUTPUT_PER_RG is true. Default value: null. - RE_REVERSE=Boolean Re-reverse bases and qualities of reads with negative strand flag set before writing them to fastq Default value: true. This option can be set to 'null' to clear the default value. Possible values: {true, false} - INCLUDE_NON_PF_READS=Boolean Include non-PF reads from the SAM file into the output FASTQ files. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false} - CLIPPING_ATTRIBUTE=String The attribute that stores the position at which the SAM record should be clipped Default value: null. - CLIPPING_ACTION=String The action that should be taken with clipped reads: 'X' means the reads and qualities should be trimmed at the clipped position; 'N' means the bases should be changed to Ns in the clipped region; and any integer means that the base qualities should be set to that value in the clipped region. Default value: null. - READ1_TRIM=Integer The number of bases to trim from the beginning of read 1. Default value: 0. This option can be set to 'null' to clear the default value. - READ1_MAX_BASES_TO_WRITE=Integer The maximum number of bases to write from read 1 after trimming. If there are fewer than this many bases left after trimming, all will be written. If this value is null then all bases left after trimming will be written. Default value: null. - READ2_TRIM=Integer The number of bases to trim from the beginning of read 2. Default value: 0. This option can be set to 'null' to clear the default value. - READ2_MAX_BASES_TO_WRITE=Integer The maximum number of bases to write from read 2 after trimming. If there are fewer than this many bases left after trimming, all will be written. If this value is null then all bases left after trimming will be written. Default value: null. - INCLUDE_NON_PRIMARY_ALIGNMENTS=Boolean If true, include non-primary alignments in the output. Support of non-primary alignments in SamToFastq is not comprehensive, so there may be exceptions if this is set to true and there are paired reads with non-primary alignments. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false} - - - -