# HG changeset patch # User devteam # Date 1481036666 18000 # Node ID e417b1d6288d40892e34dc6460e089be3774f7e5 # Parent 08f69add4d06c87416277d2246a3ca0b841394db planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e diff -r 08f69add4d06 -r e417b1d6288d picard_AddCommentsToBam.xml --- a/picard_AddCommentsToBam.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_AddCommentsToBam.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,9 +6,10 @@ - + - + - + - - + + @@ -66,42 +67,42 @@ @description@ INPUT=File - I=File Input file (bam or sam). Required. + I=File Input file (bam or sam). Required. OUTPUT=File - O=File Output file (bam or sam). Required. + O=File Output file (bam or sam). Required. SORT_ORDER=SortOrder - SO=SortOrder Optional sort order to output in. If not supplied OUTPUT is in the same order as INPUT. - Default value: null. Possible values: {unsorted, queryname, coordinate} + SO=SortOrder Optional sort order to output in. If not supplied OUTPUT is in the same order as INPUT. + Default value: null. Possible values: {unsorted, queryname, coordinate} RGID=String - ID=String Read Group ID Default value: 1. This option can be set to 'null' to clear the default - value. + ID=String Read Group ID Default value: 1. This option can be set to 'null' to clear the default + value. RGLB=String - LB=String Read Group Library Required. - + LB=String Read Group Library Required. + RGPL=String - PL=String Read Group platform (e.g. illumina, solid) Required. + PL=String Read Group platform (e.g. illumina, solid) Required. RGPU=String - PU=String Read Group platform unit (eg. run barcode) Required. + PU=String Read Group platform unit (eg. run barcode) Required. RGSM=String - SM=String Read Group sample name Required. + SM=String Read Group sample name Required. RGCN=String - CN=String Read Group sequencing center name Default value: null. + CN=String Read Group sequencing center name Default value: null. RGDS=String - DS=String Read Group description Default value: null. + DS=String Read Group description Default value: null. RGDT=Iso8601Date - DT=Iso8601Date Read Group run date Default value: null. + DT=Iso8601Date Read Group run date Default value: null. RGPI=Integer - PI=Integer Read Group predicted insert size Default value: null. + PI=Integer Read Group predicted insert size Default value: null. @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_BedToIntervalList.xml --- a/picard_BedToIntervalList.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_BedToIntervalList.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,40 +6,40 @@ - + - + @@ -54,11 +54,11 @@ - + - + @@ -74,8 +74,8 @@ - - + + .. class:: infomark diff -r 08f69add4d06 -r e417b1d6288d picard_CleanSam.xml --- a/picard_CleanSam.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_CleanSam.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,35 +6,36 @@ - + - + - + - + - - + + - + - + .. class:: infomark @@ -45,9 +46,9 @@ 1. to soft-clip an alignment that hangs off the end of its reference sequence. 2. to set MAPQ to 0 if a read is unmapped. - + @dataset_collections@ - + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_CollectAlignmentSummaryMetrics.xml --- a/picard_CollectAlignmentSummaryMetrics.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_CollectAlignmentSummaryMetrics.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,6 +6,7 @@ @@ -98,25 +99,25 @@ @description@ - MAX_INSERT_SIZE=Integer Paired end reads above this insert size will be considered chimeric along with - inter-chromosomal pairs. Default value: 100000. + MAX_INSERT_SIZE=Integer Paired end reads above this insert size will be considered chimeric along with + inter-chromosomal pairs. Default value: 100000. - ADAPTER_SEQUENCE=String List of adapter sequences to use when processing the alignment metrics This option may - be specified 0 or more times. + ADAPTER_SEQUENCE=String List of adapter sequences to use when processing the alignment metrics This option may + be specified 0 or more times. METRIC_ACCUMULATION_LEVEL=MetricAccumulationLevel - LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, - LIBRARY, READ_GROUP} This option may be specified 0 or more times. + LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, + LIBRARY, READ_GROUP} This option may be specified 0 or more times. IS_BISULFITE_SEQUENCED=Boolean - BS=Boolean Whether the SAM or BAM file consists of bisulfite sequenced reads. + BS=Boolean Whether the SAM or BAM file consists of bisulfite sequenced reads. REFERENCE_SEQUENCE=File - R=File Reference sequence fasta Default value: null. + R=File Reference sequence fasta Default value: null. ASSUME_SORTED=Boolean - AS=Boolean If true (default), then the sort order in the header file will be ignored. + AS=Boolean If true (default), then the sort order in the header file will be ignored. @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_CollectBaseDistributionByCycle.xml --- a/picard_CollectBaseDistributionByCycle.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_CollectBaseDistributionByCycle.xml Tue Dec 06 10:04:26 2016 -0500 @@ -8,30 +8,31 @@ @@ -51,19 +52,19 @@ - - - - + + + + - + - + - + @@ -75,8 +76,8 @@ - - + + .. class:: infomark @@ -89,19 +90,19 @@ @description@ - ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value: - false. This option can be set to 'null' to clear the default value. Possible values: - {true, false} + ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value: + false. This option can be set to 'null' to clear the default value. Possible values: + {true, false} - PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false. - This option can be set to 'null' to clear the default value. Possible values: {true, - false} + PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false. + This option can be set to 'null' to clear the default value. Possible values: {true, + false} REFERENCE_SEQUENCE=File - R=File Reference sequence fasta Default value: null. + R=File Reference sequence fasta Default value: null. ASSUME_SORTED=Boolean - AS=Boolean If true (default), then the sort order in the header file will be ignored. Default + AS=Boolean If true (default), then the sort order in the header file will be ignored. Default @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_CollectGcBiasMetrics.xml --- a/picard_CollectGcBiasMetrics.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_CollectGcBiasMetrics.xml Tue Dec 06 10:04:26 2016 -0500 @@ -8,6 +8,7 @@ @@ -67,16 +68,16 @@ - + - + - + - + @@ -90,8 +91,8 @@ - - + + .. class:: infomark @@ -104,30 +105,30 @@ @description@ - - DEVIATIONS=Double Generate mean, sd and plots by trimming the data down to MEDIAN + - DEVIATIONS*MEDIAN_ABSOLUTE_DEVIATION. This is done because insert size data typically - includes enough anomalous values from chimeras and other artifacts to make the mean and - sd grossly misleading regarding the real distribution. Default value: 10.0. + + DEVIATIONS=Double Generate mean, sd and plots by trimming the data down to MEDIAN + + DEVIATIONS*MEDIAN_ABSOLUTE_DEVIATION. This is done because insert size data typically + includes enough anomalous values from chimeras and other artifacts to make the mean and + sd grossly misleading regarding the real distribution. Default value: 10.0. HISTOGRAM_WIDTH=Integer - W=Integer Explicitly sets the Histogram width, overriding automatic truncation of Histogram tail. - Also, when calculating mean and standard deviation, only bins <= Histogram_WIDTH will be - included. Default value: not set. + W=Integer Explicitly sets the Histogram width, overriding automatic truncation of Histogram tail. + Also, when calculating mean and standard deviation, only bins <= Histogram_WIDTH will be + included. Default value: not set. MINIMUM_PCT=Float - M=Float When generating the Histogram, discard any data categories (out of FR, TANDEM, RF) that - have fewer than this percentage of overall reads. (Range: 0 to 1). Default value: 0.05. + M=Float When generating the Histogram, discard any data categories (out of FR, TANDEM, RF) that + have fewer than this percentage of overall reads. (Range: 0 to 1). Default value: 0.05. METRIC_ACCUMULATION_LEVEL=MetricAccumulationLevel - LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, - LIBRARY, READ_GROUP} This option may be specified 0 or more times. - + LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, + LIBRARY, READ_GROUP} This option may be specified 0 or more times. + ASSUME_SORTED=Boolean - AS=Boolean If true (default), then the sort order in the header file will be ignored. Default - value: true. This option can be set to 'null' to clear the default value. Possible + AS=Boolean If true (default), then the sort order in the header file will be ignored. Default + value: true. This option can be set to 'null' to clear the default value. Possible values: {true, false} - + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_CollectRnaSeqMetrics.xml --- a/picard_CollectRnaSeqMetrics.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_CollectRnaSeqMetrics.xml Tue Dec 06 10:04:26 2016 -0500 @@ -9,33 +9,33 @@ refFlat.tab && - + ## Start picard command - + @java_options@ picard CollectRnaSeqMetrics REF_FLAT=refFlat.tab - + #if str( $ribosomal_intervals ) != "None": RIBOSOMAL_INTERVALS="${ribosomal_intervals}" #end if - + STRAND_SPECIFICITY="${strand_specificity}" MINIMUM_LENGTH="${minimum_length}" CHART_OUTPUT="${pdfFile}" @@ -43,20 +43,20 @@ #for $sequence_to_ignore in $ignore_list: IGNORE_SEQUENCE="${sequence_to_ignore.sequence}" #end for - + RRNA_FRAGMENT_PERCENTAGE="${rrna_fragment_percentage}" METRIC_ACCUMULATION_LEVEL="${metric_accumulation_level}" - INPUT="${inputFile}" + INPUT='$inputFile.element_identifier' OUTPUT="${outFile}" REFERENCE_SEQUENCE="${reference_fasta_filename}" ASSUME_SORTED="${assume_sorted}" - + QUIET=true VERBOSITY=ERROR VALIDATION_STRINGENCY=${validation_stringency} - + ]]> - + @@ -73,7 +73,7 @@ - + @@ -93,7 +93,7 @@ - + @@ -101,7 +101,7 @@ - + @@ -156,41 +156,41 @@ 8. Click **Send query to Galaxy** 9. A new dataset will appear in the current Galaxy history 10. Use this dataset as the input for **Gene annotations in refFlat form** dropdown of this tool - + .. _refFlat: http://genome.ucsc.edu/goldenPath/gbdDescriptionsOld.html#RefFlat @description@ - REF_FLAT=File Gene annotations in refFlat form. Format described here: - http://genome.ucsc.edu/goldenPath/gbdDescriptionsOld.html#RefFlat Required. + REF_FLAT=File Gene annotations in refFlat form. Format described here: + http://genome.ucsc.edu/goldenPath/gbdDescriptionsOld.html#RefFlat Required. - RIBOSOMAL_INTERVALS=File Location of rRNA sequences in genome, in interval_list format. If not specified no bases - will be identified as being ribosomal. Format described here: + RIBOSOMAL_INTERVALS=File Location of rRNA sequences in genome, in interval_list format. If not specified no bases + will be identified as being ribosomal. Format described here: http://picard.sourceforge.net/javadoc/net/sf/picard/util/IntervalList.html and can be generated from BED datasetes using Galaxy's wrapper for picard_BedToIntervalList tool STRAND_SPECIFICITY=StrandSpecificity - STRAND=StrandSpecificity For strand-specific library prep. For unpaired reads, use FIRST_READ_TRANSCRIPTION_STRAND - if the reads are expected to be on the transcription strand. Required. Possible values: - {NONE, FIRST_READ_TRANSCRIPTION_STRAND, SECOND_READ_TRANSCRIPTION_STRAND} + STRAND=StrandSpecificity For strand-specific library prep. For unpaired reads, use FIRST_READ_TRANSCRIPTION_STRAND + if the reads are expected to be on the transcription strand. Required. Possible values: + {NONE, FIRST_READ_TRANSCRIPTION_STRAND, SECOND_READ_TRANSCRIPTION_STRAND} - MINIMUM_LENGTH=Integer When calculating coverage based values (e.g. CV of coverage) only use transcripts of this + MINIMUM_LENGTH=Integer When calculating coverage based values (e.g. CV of coverage) only use transcripts of this length or greater. Default value: 500. - IGNORE_SEQUENCE=String If a read maps to a sequence specified with this option, all the bases in the read are - counted as ignored bases. + IGNORE_SEQUENCE=String If a read maps to a sequence specified with this option, all the bases in the read are + counted as ignored bases. RRNA_FRAGMENT_PERCENTAGE=Double - This percentage of the length of a fragment must overlap one of the ribosomal intervals - for a read or read pair by this must in order to be considered rRNA. Default value: 0.8. + This percentage of the length of a fragment must overlap one of the ribosomal intervals + for a read or read pair by this must in order to be considered rRNA. Default value: 0.8. METRIC_ACCUMULATION_LEVEL=MetricAccumulationLevel - LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, + LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, LIBRARY, READ_GROUP} This option may be specified 0 or more times. - + ASSUME_SORTED=Boolean - AS=Boolean If true (default), then the sort order in the header file will be ignored. Default - value: true. Possible values: {true, false} + AS=Boolean If true (default), then the sort order in the header file will be ignored. Default + value: true. Possible values: {true, false} @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_CollectWgsMetrics.xml --- a/picard_CollectWgsMetrics.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_CollectWgsMetrics.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,29 +6,30 @@ @@ -52,15 +53,15 @@ - + - + - + - + @@ -70,10 +71,10 @@ - + - - + + .. class:: infomark @@ -87,14 +88,14 @@ @description@ MINIMUM_MAPPING_QUALITY=Integer - MQ=Integer Minimum mapping quality for a read to contribute coverage. Default value: 20. + MQ=Integer Minimum mapping quality for a read to contribute coverage. Default value: 20. MINIMUM_BASE_QUALITY=Integer - Q=Integer Minimum base quality for a base to contribute coverage. Default value: 20. + Q=Integer Minimum base quality for a base to contribute coverage. Default value: 20. COVERAGE_CAP=Integer - CAP=Integer Treat bases with coverage exceeding this value as if they had coverage at this value. - Default value: 250. + CAP=Integer Treat bases with coverage exceeding this value as if they had coverage at this value. + Default value: 250. @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_DownsampleSam.xml --- a/picard_DownsampleSam.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_DownsampleSam.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,9 +6,10 @@ - + - + - - + + - + @@ -52,18 +53,18 @@ @description@ INPUT=File - I=File The input SAM or BAM file to downsample. Required. + I=File The input SAM or BAM file to downsample. Required. OUTPUT=File - O=File The output, downsampled, SAM or BAM file to write. Required. + O=File The output, downsampled, SAM or BAM file to write. Required. RANDOM_SEED=Long R=Long Random seed to use if reproducibilty is desired. Setting to null will cause multiple invocations to produce different results. - + PROBABILITY=Double - P=Double The probability of keeping any individual read, between 0 and 1. - + P=Double The probability of keeping any individual read, between 0 and 1. + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_EstimateLibraryComplexity.xml --- a/picard_EstimateLibraryComplexity.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_EstimateLibraryComplexity.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,13 +6,13 @@ @@ -42,13 +42,13 @@ - - - + + + - + @@ -62,8 +62,8 @@ - - + + **Purpose** @@ -86,40 +86,40 @@ @description@ - MIN_IDENTICAL_BASES=Integer The minimum number of bases at the starts of reads that must be identical for reads to be - grouped together for duplicate detection. In effect total_reads / 4^max_id_bases reads - will be compared at a time, so lower numbers will produce more accurate results but - consume exponentially more memory and CPU. Default value: 5. - - MAX_DIFF_RATE=Double The maximum rate of differences between two reads to call them identical. Default value: + MIN_IDENTICAL_BASES=Integer The minimum number of bases at the starts of reads that must be identical for reads to be + grouped together for duplicate detection. In effect total_reads / 4^max_id_bases reads + will be compared at a time, so lower numbers will produce more accurate results but + consume exponentially more memory and CPU. Default value: 5. + + MAX_DIFF_RATE=Double The maximum rate of differences between two reads to call them identical. Default value: 0.03. - - MIN_MEAN_QUALITY=Integer The minimum mean quality of the bases in a read pair for the read to be analyzed. Reads - with lower average quality are filtered out and not considered in any calculations. + + MIN_MEAN_QUALITY=Integer The minimum mean quality of the bases in a read pair for the read to be analyzed. Reads + with lower average quality are filtered out and not considered in any calculations. Default value: 20. - - MAX_GROUP_RATIO=Integer Do not process self-similar groups that are this many times over the mean expected group - size. I.e. if the input contains 10m read pairs and MIN_IDENTICAL_BASES is set to 5, then + + MAX_GROUP_RATIO=Integer Do not process self-similar groups that are this many times over the mean expected group + size. I.e. if the input contains 10m read pairs and MIN_IDENTICAL_BASES is set to 5, then the mean expected group size would be approximately 10 reads. Default value: 500. - - READ_NAME_REGEX=String Regular expression that can be used to parse read names in the incoming SAM file. Read - names are parsed to extract three variables: tile/region, x coordinate and y coordinate. - These values are used to estimate the rate of optical duplication in order to give a more - accurate estimated library size. Set this option to null to disable optical duplicate - detection. The regular expression should contain three capture groups for the three - variables, in order. It must match the entire read name. Note that if the default regex - is specified, a regex match is not actually done, but instead the read name is split on - colon character. For 5 element names, the 3rd, 4th and 5th elements are assumed to be - tile, x and y values. For 7 element names (CASAVA 1.8), the 5th, 6th, and 7th elements - are assumed to be tile, x and y values. Default value: + + READ_NAME_REGEX=String Regular expression that can be used to parse read names in the incoming SAM file. Read + names are parsed to extract three variables: tile/region, x coordinate and y coordinate. + These values are used to estimate the rate of optical duplication in order to give a more + accurate estimated library size. Set this option to null to disable optical duplicate + detection. The regular expression should contain three capture groups for the three + variables, in order. It must match the entire read name. Note that if the default regex + is specified, a regex match is not actually done, but instead the read name is split on + colon character. For 5 element names, the 3rd, 4th and 5th elements are assumed to be + tile, x and y values. For 7 element names (CASAVA 1.8), the 5th, 6th, and 7th elements + are assumed to be tile, x and y values. Default value: [a-zA-Z0-9]+:[0-9]:([0-9]+):([0-9]+):([0-9]+).*. - - OPTICAL_DUPLICATE_PIXEL_DISTANCE=Integer - The maximum offset between two duplicte clusters in order to consider them optical - duplicates. This should usually be set to some fairly small number (e.g. 5-10 pixels) - unless using later versions of the Illumina pipeline that multiply pixel values by 10, in + + OPTICAL_DUPLICATE_PIXEL_DISTANCE=Integer + The maximum offset between two duplicte clusters in order to consider them optical + duplicates. This should usually be set to some fairly small number (e.g. 5-10 pixels) + unless using later versions of the Illumina pipeline that multiply pixel values by 10, in which case 50-100 is more normal. Default value: 100. - + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_FastqToSam.xml --- a/picard_FastqToSam.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_FastqToSam.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,10 +6,9 @@ @@ -86,7 +85,7 @@ - + @@ -108,15 +107,15 @@ - + - - - + + + - + @@ -139,9 +138,9 @@ - + - + .. class:: infomark @@ -157,62 +156,62 @@ @description@ FASTQ=File - F1=File Input fastq file for single end data, or first read in paired end + F1=File Input fastq file for single end data, or first read in paired end data. Required. - + FASTQ2=File - F2=File Input fastq file for the second read of paired end data (if used). + F2=File Input fastq file for the second read of paired end data (if used). QUALITY_FORMAT=FastqQualityFormat - V=FastqQualityFormat A value describing how the quality values are encoded in the fastq. Either Solexa for - pre-pipeline 1.3 style scores (solexa scaling + 66), Illumina for pipeline 1.3 and above - (phred scaling + 64) or Standard for phred scaled scores with a character shift of 33. - If this value is not specified, the quality format will be detected automatically. - Default value: null. Possible values: {Solexa, Illumina, Standard} + V=FastqQualityFormat A value describing how the quality values are encoded in the fastq. Either Solexa for + pre-pipeline 1.3 style scores (solexa scaling + 66), Illumina for pipeline 1.3 and above + (phred scaling + 64) or Standard for phred scaled scores with a character shift of 33. + If this value is not specified, the quality format will be detected automatically. + Default value: null. Possible values: {Solexa, Illumina, Standard} READ_GROUP_NAME=String - RG=String Read group name Default value: A. - + RG=String Read group name Default value: A. + SAMPLE_NAME=String - SM=String Sample name to insert into the read group header Required. - + SM=String Sample name to insert into the read group header Required. + LIBRARY_NAME=String LB=String The library name to place into the LB attribute in the read group header. - + PLATFORM_UNIT=String PU=String The platform unit (often run_barcode.lane) to insert into the read group header. - + PLATFORM=String PL=String The platform type (e.g. illumina, solid) to insert into the read group header. - + SEQUENCING_CENTER=String CN=String The sequencing center from which the data originated. - + PREDICTED_INSERT_SIZE=Integer PI=Integer Predicted median insert size, to insert into the read group header. - + COMMENT=String - CO=String Comment to include in the merged output file's header. - + CO=String Comment to include in the merged output file's header. + DESCRIPTION=String - DS=String Inserted into the read group header. - + DS=String Inserted into the read group header. + RUN_DATE=Iso8601Date - DT=Iso8601Date Date the run was produced, to insert into the read group header. - - MIN_Q=Integer Minimum quality allowed in the input fastq. An exception will be thrown if a quality is + DT=Iso8601Date Date the run was produced, to insert into the read group header. + + MIN_Q=Integer Minimum quality allowed in the input fastq. An exception will be thrown if a quality is less than this value. Default value: 0. - - MAX_Q=Integer Maximum quality allowed in the input fastq. An exception will be thrown if a quality is + + MAX_Q=Integer Maximum quality allowed in the input fastq. An exception will be thrown if a quality is greater than this value. Default value: 93. - + STRIP_UNPAIRED_MATE_NUMBER=Boolean - If true and this is an unpaired fastq any occurance of '/1' will be removed from the end - of a read name. Default value: false. Possible values: {true, false} - + If true and this is an unpaired fastq any occurance of '/1' will be removed from the end + of a read name. Default value: false. Possible values: {true, false} + ALLOW_AND_IGNORE_EMPTY_LINES=Boolean - Allow (and ignore) empty lines Default value: false. Possible values: {true, false} - + Allow (and ignore) empty lines Default value: false. Possible values: {true, false} + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_FilterSamReads.xml --- a/picard_FilterSamReads.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_FilterSamReads.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,35 +6,35 @@ @@ -54,15 +54,15 @@ - + - - - + + + - + @@ -79,8 +79,8 @@ - - + + **Purpose** @@ -93,32 +93,32 @@ **Warning on using this tool on BWA-MEM output** -This tool will likely fail on BAM datasets generated by BWA MEM as it generates partial read alignemnts. +This tool will likely fail on BAM datasets generated by BWA MEM as it generates partial read alignemnts. @dataset_collections@ @description@ FILTER=Filter Filter. Required. Possible values: - includeAligned [OUTPUT SAM/BAM will contain aligned - reads only. (Note that *both* first and + includeAligned [OUTPUT SAM/BAM will contain aligned + reads only. (Note that *both* first and second of paired reads must be aligned to be included - in the OUTPUT SAM or BAM)], - + in the OUTPUT SAM or BAM)], + excludeAligned [OUTPUT SAM/BAM will contain un-mapped reads only. - (Note that *both* first and second of pair must be aligned to be + (Note that *both* first and second of pair must be aligned to be excluded from the OUTPUT SAM or BAM)] - - includeReadList [OUTPUT SAM/BAM will contain reads + + includeReadList [OUTPUT SAM/BAM will contain reads that are supplied in the READ_LIST_FILE file] - - excludeReadList [OUTPUT bam will contain - reads that are *not* supplied in the READ_LIST_FILE file]} + + excludeReadList [OUTPUT bam will contain + reads that are *not* supplied in the READ_LIST_FILE file]} READ_LIST_FILE=File - RLF=File Read List File containing reads that will be included or excluded from the OUTPUT SAM or - BAM file. Default value: null. - + RLF=File Read List File containing reads that will be included or excluded from the OUTPUT SAM or + BAM file. Default value: null. + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_FixMateInformation.xml --- a/picard_FixMateInformation.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_FixMateInformation.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,33 +6,32 @@ - + - - - + + + - + @@ -42,8 +41,8 @@ - - + + **Purpose** @@ -64,12 +63,12 @@ @description@ ASSUME_SORTED=Boolean - AS=Boolean If true, assume that the input file is queryname sorted, even if the header says - otherwise. Default value: false. - + AS=Boolean If true, assume that the input file is queryname sorted, even if the header says + otherwise. Default value: false. + ADD_MATE_CIGAR=Boolean - MC=Boolean Adds the mate CIGAR tag (MC) if true, does not if false. Default value: true. - + MC=Boolean Adds the mate CIGAR tag (MC) if true, does not if false. Default value: true. + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_MarkDuplicates.xml --- a/picard_MarkDuplicates.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_MarkDuplicates.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,11 +6,11 @@ - + @@ -60,14 +60,14 @@ - - - + + + - + @@ -83,8 +83,8 @@ - - + + **Purpose** @@ -110,44 +110,44 @@ @description@ - MINIMUM_DISTANCE=Integer The minimum distance to buffer records to account for clipping on the 5' end of the - records.Set this number to -1 to use twice the first read's read length (or 100, - whichever is smaller). Default value: -1. This option can be set to 'null' to clear the - default value. - + MINIMUM_DISTANCE=Integer The minimum distance to buffer records to account for clipping on the 5' end of the + records.Set this number to -1 to use twice the first read's read length (or 100, + whichever is smaller). Default value: -1. This option can be set to 'null' to clear the + default value. + SKIP_PAIRS_WITH_NO_MATE_CIGAR=Boolean - Skip record pairs with no mate cigar and include them in the output. Default value: - true. This option can be set to 'null' to clear the default value. Possible values: - {true, false} + Skip record pairs with no mate cigar and include them in the output. Default value: + true. This option can be set to 'null' to clear the default value. Possible values: + {true, false} - COMMENT=String - CO=String Comment(s) to include in the output file's header. This option may be specified 0 or - more times. + COMMENT=String + CO=String Comment(s) to include in the output file's header. This option may be specified 0 or + more times. + + REMOVE_DUPLICATES=Boolean If true do not write duplicates to the output file instead of writing them with + appropriate flags set. Default value: false. - REMOVE_DUPLICATES=Boolean If true do not write duplicates to the output file instead of writing them with - appropriate flags set. Default value: false. - - READ_NAME_REGEX=String Regular expression that can be used to parse read names in the incoming SAM file. Read - names are parsed to extract three variables: tile/region, x coordinate and y coordinate. - These values are used to estimate the rate of optical duplication in order to give a more - accurate estimated library size. Set this option to null to disable optical duplicate - detection. The regular expression should contain three capture groups for the three - variables, in order. It must match the entire read name. Note that if the default regex - is specified, a regex match is not actually done, but instead the read name is split on - colon character. For 5 element names, the 3rd, 4th and 5th elements are assumed to be - tile, x and y values. For 7 element names (CASAVA 1.8), the 5th, 6th, and 7th elements - are assumed to be tile, x and y values. Default value: + READ_NAME_REGEX=String Regular expression that can be used to parse read names in the incoming SAM file. Read + names are parsed to extract three variables: tile/region, x coordinate and y coordinate. + These values are used to estimate the rate of optical duplication in order to give a more + accurate estimated library size. Set this option to null to disable optical duplicate + detection. The regular expression should contain three capture groups for the three + variables, in order. It must match the entire read name. Note that if the default regex + is specified, a regex match is not actually done, but instead the read name is split on + colon character. For 5 element names, the 3rd, 4th and 5th elements are assumed to be + tile, x and y values. For 7 element names (CASAVA 1.8), the 5th, 6th, and 7th elements + are assumed to be tile, x and y values. Default value: [a-zA-Z0-9]+:[0-9]:([0-9]+):([0-9]+):([0-9]+).*. - + DUPLICATE_SCORING_STRATEGY=ScoringStrategy - DS=ScoringStrategy The scoring strategy for choosing the non-duplicate among candidates. Default value: - TOTAL_MAPPED_REFERENCE_LENGTH. Possible values: {SUM_OF_BASE_QUALITIES, TOTAL_MAPPED_REFERENCE_LENGTH} - + DS=ScoringStrategy The scoring strategy for choosing the non-duplicate among candidates. Default value: + TOTAL_MAPPED_REFERENCE_LENGTH. Possible values: {SUM_OF_BASE_QUALITIES, TOTAL_MAPPED_REFERENCE_LENGTH} + OPTICAL_DUPLICATE_PIXEL_DISTANCE=Integer - The maximum offset between two duplicte clusters in order to consider them optical - duplicates. This should usually be set to some fairly small number (e.g. 5-10 pixels) - unless using later versions of the Illumina pipeline that multiply pixel values by 10, in - which case 50-100 is more normal. Default value: 100. + The maximum offset between two duplicte clusters in order to consider them optical + duplicates. This should usually be set to some fairly small number (e.g. 5-10 pixels) + unless using later versions of the Illumina pipeline that multiply pixel values by 10, in + which case 50-100 is more normal. Default value: 100. @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_MeanQualityByCycle.xml --- a/picard_MeanQualityByCycle.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_MeanQualityByCycle.xml Tue Dec 06 10:04:26 2016 -0500 @@ -9,30 +9,30 @@ @@ -55,16 +55,16 @@ - + - + - + - + @@ -74,31 +74,31 @@ - + - - + + .. class:: infomark **Purpose** -Program to chart the distribution of base qualities by cycle within reads supplied in a SAM or BAM dataset. +Program to chart the distribution of base qualities by cycle within reads supplied in a SAM or BAM dataset. @dataset_collections@ @description@ - ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value: - false. Possible values: {true, false} + ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value: + false. Possible values: {true, false} - PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false. - This option can be set to 'null' to clear the default value. Possible values: {true, - false} + PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false. + This option can be set to 'null' to clear the default value. Possible values: {true, + false} ASSUME_SORTED=Boolean - AS=Boolean If true (default), then the sort order in the header file will be ignored. Default: True + AS=Boolean If true (default), then the sort order in the header file will be ignored. Default: True @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_MergeBamAlignment.xml --- a/picard_MergeBamAlignment.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_MergeBamAlignment.xml Tue Dec 06 10:04:26 2016 -0500 @@ -8,29 +8,29 @@ @java_options@ #set $picard_dict = "localref.dict" #set $ref_fasta = "localref.fa" ## This is done because picards "likes" .fa extension - + ln -s "${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}" @@ -47,48 +47,48 @@ 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}" + + 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 - + ]]> - + - + @@ -103,11 +103,11 @@ - + - + @@ -134,39 +134,39 @@ - + - + - + - + - + - - + + - + - + @@ -197,8 +197,8 @@ - - + + .. class:: infomark @@ -212,96 +212,96 @@ @description@ UNMAPPED_BAM=File - UNMAPPED=File Original SAM or BAM file of unmapped reads, which must be in queryname order. Required. - + UNMAPPED=File Original SAM or BAM file of unmapped reads, which must be in queryname order. Required. + ALIGNED_BAM=File - ALIGNED=File SAM or BAM file(s) with alignment data. This option may be specified 0 or more times. - Cannot be used in conjuction with option(s) READ1_ALIGNED_BAM (R1_ALIGNED) + ALIGNED=File SAM or BAM file(s) with alignment data. This option may be specified 0 or more times. + Cannot be used in conjuction with option(s) READ1_ALIGNED_BAM (R1_ALIGNED) READ2_ALIGNED_BAM (R2_ALIGNED) - + READ1_ALIGNED_BAM=File - R1_ALIGNED=File SAM or BAM file(s) with alignment data from the first read of a pair. This option may be - specified 0 or more times. Cannot be used in conjuction with option(s) ALIGNED_BAM + R1_ALIGNED=File SAM or BAM file(s) with alignment data from the first read of a pair. This option may be + specified 0 or more times. Cannot be used in conjuction with option(s) ALIGNED_BAM (ALIGNED) - + READ2_ALIGNED_BAM=File - R2_ALIGNED=File SAM or BAM file(s) with alignment data from the second read of a pair. This option may - be specified 0 or more times. Cannot be used in conjuction with option(s) ALIGNED_BAM + R2_ALIGNED=File SAM or BAM file(s) with alignment data from the second read of a pair. This option may + be specified 0 or more times. Cannot be used in conjuction with option(s) ALIGNED_BAM (ALIGNED) - + PAIRED_RUN=Boolean - PE=Boolean This argument is ignored and will be removed. Required. Possible values: {true, false} - + PE=Boolean This argument is ignored and will be removed. Required. Possible values: {true, false} + JUMP_SIZE=Integer - JUMP=Integer The expected jump size (required if this is a jumping library). Deprecated. Use - EXPECTED_ORIENTATIONS instead Default value: null. Cannot be used in conjuction with + JUMP=Integer The expected jump size (required if this is a jumping library). Deprecated. Use + EXPECTED_ORIENTATIONS instead Default value: null. Cannot be used in conjuction with option(s) EXPECTED_ORIENTATIONS (ORIENTATIONS) - - CLIP_ADAPTERS=Boolean Whether to clip adapters where identified. Default value: true. Possible values: {true, false} - - IS_BISULFITE_SEQUENCE=Boolean Whether the lane is bisulfite sequence (used when caculating the NM tag). Default value: - false. Possible values: {true, false} - - ALIGNED_READS_ONLY=Boolean Whether to output only aligned reads. Default value: false. Possible values: {true, false} - + + CLIP_ADAPTERS=Boolean Whether to clip adapters where identified. Default value: true. Possible values: {true, false} + + IS_BISULFITE_SEQUENCE=Boolean Whether the lane is bisulfite sequence (used when caculating the NM tag). Default value: + false. Possible values: {true, false} + + ALIGNED_READS_ONLY=Boolean Whether to output only aligned reads. Default value: false. Possible values: {true, false} + MAX_INSERTIONS_OR_DELETIONS=Integer - MAX_GAPS=Integer The maximum number of insertions or deletions permitted for an alignment to be included. - Alignments with more than this many insertions or deletions will be ignored. Set to -1 to + MAX_GAPS=Integer The maximum number of insertions or deletions permitted for an alignment to be included. + Alignments with more than this many insertions or deletions will be ignored. Set to -1 to allow any number of insertions or deletions. Default value: 1. - - ATTRIBUTES_TO_RETAIN=String Reserved alignment attributes (tags starting with X, Y, or Z) that should be brought over - from the alignment data when merging. This option may be specified 0 or more times. - - ATTRIBUTES_TO_REMOVE=String Attributes from the alignment record that should be removed when merging. This overrides - ATTRIBUTES_TO_RETAIN if they share common tags. This option may be specified 0 or more - times. - + + ATTRIBUTES_TO_RETAIN=String Reserved alignment attributes (tags starting with X, Y, or Z) that should be brought over + from the alignment data when merging. This option may be specified 0 or more times. + + ATTRIBUTES_TO_REMOVE=String Attributes from the alignment record that should be removed when merging. This overrides + ATTRIBUTES_TO_RETAIN if they share common tags. This option may be specified 0 or more + times. + READ1_TRIM=Integer - R1_TRIM=Integer The number of bases trimmed from the beginning of read 1 prior to alignment Default - value: 0. - + R1_TRIM=Integer The number of bases trimmed from the beginning of read 1 prior to alignment Default + value: 0. + READ2_TRIM=Integer - R2_TRIM=Integer The number of bases trimmed from the beginning of read 2 prior to alignment Default - value: 0. - + R2_TRIM=Integer The number of bases trimmed from the beginning of read 2 prior to alignment Default + value: 0. + EXPECTED_ORIENTATIONS=PairOrientation - ORIENTATIONS=PairOrientation The expected orientation of proper read pairs. Replaces JUMP_SIZE Possible values: {FR, - RF, TANDEM} This option may be specified 0 or more times. Cannot be used in conjuction + ORIENTATIONS=PairOrientation The expected orientation of proper read pairs. Replaces JUMP_SIZE Possible values: {FR, + RF, TANDEM} This option may be specified 0 or more times. Cannot be used in conjuction with option(s) JUMP_SIZE (JUMP) - + ALIGNER_PROPER_PAIR_FLAGS=Boolean - Use the aligner's idea of what a proper pair is rather than computing in this program. - Default value: false. Possible values: {true, false} - + Use the aligner's idea of what a proper pair is rather than computing in this program. + Default value: false. Possible values: {true, false} + SORT_ORDER=SortOrder SO=SortOrder The order in which the merged reads should be output. Default value: coordinate. - Possible values: {unsorted, queryname, coordinate} - + Possible values: {unsorted, queryname, coordinate} + PRIMARY_ALIGNMENT_STRATEGY=PrimaryAlignmentStrategy - Strategy for selecting primary alignment when the aligner has provided more than one - alignment for a pair or fragment, and none are marked as primary, more than one is marked - as primary, or the primary alignment is filtered out for some reason. BestMapq expects - that multiple alignments will be correlated with HI tag, and prefers the pair of - alignments with the largest MAPQ, in the absence of a primary selected by the aligner. - EarliestFragment prefers the alignment which maps the earliest base in the read. Note - that EarliestFragment may not be used for paired reads. BestEndMapq is appropriate for - cases in which the aligner is not pair-aware, and does not output the HI tag. It simply - picks the alignment for each end with the highest MAPQ, and makes those alignments - primary, regardless of whether the two alignments make sense together.MostDistant is also - for a non-pair-aware aligner, and picks the alignment pair with the largest insert size. - If all alignments would be chimeric, it picks the alignments for each end with the best + Strategy for selecting primary alignment when the aligner has provided more than one + alignment for a pair or fragment, and none are marked as primary, more than one is marked + as primary, or the primary alignment is filtered out for some reason. BestMapq expects + that multiple alignments will be correlated with HI tag, and prefers the pair of + alignments with the largest MAPQ, in the absence of a primary selected by the aligner. + EarliestFragment prefers the alignment which maps the earliest base in the read. Note + that EarliestFragment may not be used for paired reads. BestEndMapq is appropriate for + cases in which the aligner is not pair-aware, and does not output the HI tag. It simply + picks the alignment for each end with the highest MAPQ, and makes those alignments + primary, regardless of whether the two alignments make sense together.MostDistant is also + for a non-pair-aware aligner, and picks the alignment pair with the largest insert size. + If all alignments would be chimeric, it picks the alignments for each end with the best MAPQ. For all algorithms, ties are resolved arbitrarily. Default value: BestMapq. - Possible values: {BestMapq, EarliestFragment, BestEndMapq, MostDistant} - - CLIP_OVERLAPPING_READS=BooleanFor paired reads, soft clip the 3' end of each read if necessary so that it does not - extend past the 5' end of its mate. Default value: true. Possible values: {true, false} - + Possible values: {BestMapq, EarliestFragment, BestEndMapq, MostDistant} + + CLIP_OVERLAPPING_READS=BooleanFor paired reads, soft clip the 3' end of each read if necessary so that it does not + extend past the 5' end of its mate. Default value: true. Possible values: {true, false} + INCLUDE_SECONDARY_ALIGNMENTS=Boolean If false, do not write secondary alignments to output. Default value: true. - Possible values: {true, false} - + Possible values: {true, false} + ADD_MATE_CIGAR=Boolean - MC=Boolean Adds the mate CIGAR tag (MC) if true, does not if false. Possible values: {true, false} + MC=Boolean Adds the mate CIGAR tag (MC) if true, does not if false. Possible values: {true, false} diff -r 08f69add4d06 -r e417b1d6288d picard_MergeSamFiles.xml --- a/picard_MergeSamFiles.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_MergeSamFiles.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,17 +6,16 @@ @@ -37,15 +36,15 @@ - + - - - + + + - + @@ -55,8 +54,8 @@ - - + + **Purpose** @@ -68,17 +67,17 @@ @description@ ASSUME_SORTED=Boolean - AS=Boolean If true, assume that the input files are in the same sort order as the requested output - sort order, even if their headers say otherwise. Default value: false. This option can - be set to 'null' to clear the default value. Possible values: {true, false} - + AS=Boolean If true, assume that the input files are in the same sort order as the requested output + sort order, even if their headers say otherwise. Default value: false. This option can + be set to 'null' to clear the default value. Possible values: {true, false} + MERGE_SEQUENCE_DICTIONARIES=Boolean - MSD=Boolean Merge the sequence dictionaries Default value: false. This option can be set to 'null' - to clear the default value. Possible values: {true, false} - + MSD=Boolean Merge the sequence dictionaries Default value: false. This option can be set to 'null' + to clear the default value. Possible values: {true, false} + COMMENT=String - CO=String Comment(s) to include in the merged output file's header. This option may be specified 0 - or more times. + CO=String Comment(s) to include in the merged output file's header. This option may be specified 0 + or more times. @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_NormalizeFasta.xml --- a/picard_NormalizeFasta.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_NormalizeFasta.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,34 +6,32 @@ - - + + - + @@ -42,8 +40,8 @@ - - + + **Purpose** @@ -54,10 +52,10 @@ @description@ - LINE_LENGTH=Integer The line length to be used for the output fasta file. Default value: 100. - + LINE_LENGTH=Integer The line length to be used for the output fasta file. Default value: 100. + TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE=Boolean - Truncate sequence names at first whitespace. Default value: false. Possible values: {true, false} + Truncate sequence names at first whitespace. Default value: false. Possible values: {true, false} @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_QualityScoreDistribution.xml --- a/picard_QualityScoreDistribution.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_QualityScoreDistribution.xml Tue Dec 06 10:04:26 2016 -0500 @@ -9,31 +9,31 @@ @@ -57,16 +57,16 @@ - + - + - + - + @@ -77,10 +77,10 @@ - + - - + + .. class:: infomark @@ -93,17 +93,17 @@ @description@ - ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value: - false. Possible values: {true, false} + ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value: + false. Possible values: {true, false} - PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false. + PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false. Possible values: {true, false} - - INCLUDE_NO_CALLS=Boolean If set to true, include quality for no-call bases in the distribution. Default value: - false. Possible values: {true, false} + + INCLUDE_NO_CALLS=Boolean If set to true, include quality for no-call bases in the distribution. Default value: + false. Possible values: {true, false} ASSUME_SORTED=Boolean - AS=Boolean If true (default), then the sort order in the header file will be ignored. Default: True + AS=Boolean If true (default), then the sort order in the header file will be ignored. Default: True @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_ReorderSam.xml --- a/picard_ReorderSam.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_ReorderSam.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,41 +6,42 @@ - + - + @@ -55,7 +56,7 @@ - + @@ -64,7 +65,7 @@ - + @@ -79,8 +80,8 @@ - - + + .. class:: infomark @@ -100,14 +101,14 @@ @description@ ALLOW_INCOMPLETE_DICT_CONCORDANCE=Boolean - S=Boolean If true, then allows only a partial overlap of the BAM contigs with the new reference - sequence contigs. By default, this tool requires a corresponding contig in the new - reference for each read contig Default value: false. Possible values: {true, false} - + S=Boolean If true, then allows only a partial overlap of the BAM contigs with the new reference + sequence contigs. By default, this tool requires a corresponding contig in the new + reference for each read contig Default value: false. Possible values: {true, false} + ALLOW_CONTIG_LENGTH_DISCORDANCE=Boolean - U=Boolean If true, then permits mapping from a read contig to a new reference contig with the same - name but a different length. Highly dangerous, only use if you know what you are doing. - Default value: false. Possible values: {true, false} + U=Boolean If true, then permits mapping from a read contig to a new reference contig with the same + name but a different length. Highly dangerous, only use if you know what you are doing. + Default value: false. Possible values: {true, false} @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_ReplaceSamHeader.xml --- a/picard_ReplaceSamHeader.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_ReplaceSamHeader.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,32 +6,32 @@ - - + + - + @@ -39,8 +39,8 @@ - - + + **Purpose** @@ -50,7 +50,7 @@ @description@ - HEADER=File SAM file from which SAMFileHeader will be read. Required. + HEADER=File SAM file from which SAMFileHeader will be read. Required. @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_RevertOriginalBaseQualitiesAndAddMateCigar.xml --- a/picard_RevertOriginalBaseQualitiesAndAddMateCigar.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_RevertOriginalBaseQualitiesAndAddMateCigar.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,21 +6,20 @@ @@ -28,13 +27,13 @@ - - - + + + - + @@ -44,8 +43,8 @@ - - + + **Purpose** @@ -57,11 +56,11 @@ @description@ RESTORE_ORIGINAL_QUALITIES=Boolean - OQ=Boolean True to restore original qualities from the OQ field to the QUAL field if available. - Default value: true. Possible values: {true, false} - - MAX_RECORDS_TO_EXAMINE=IntegerThe maximum number of records to examine to determine if we can exit early and not - output, given that there are a no original base qualities (if we are to restore) and mate + OQ=Boolean True to restore original qualities from the OQ field to the QUAL field if available. + Default value: true. Possible values: {true, false} + + MAX_RECORDS_TO_EXAMINE=IntegerThe maximum number of records to examine to determine if we can exit early and not + output, given that there are a no original base qualities (if we are to restore) and mate cigars exist. Set to 0 to never skip the file. Default value: 10000. @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_RevertSam.xml --- a/picard_RevertSam.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_RevertSam.xml Tue Dec 06 10:04:26 2016 -0500 @@ -6,31 +6,30 @@ @@ -50,13 +49,13 @@ - - - + + + - + @@ -73,8 +72,8 @@ - - + + **Purpose** @@ -85,46 +84,46 @@ @description@ - SORT_ORDER=SortOrder + SORT_ORDER=SortOrder SO=SortOrder The sort order to create the reverted output file with. Default value: queryname. - Possible values: {unsorted, queryname, coordinate} - + Possible values: {unsorted, queryname, coordinate} + RESTORE_ORIGINAL_QUALITIES=Boolean - OQ=Boolean True to restore original qualities from the OQ field to the QUAL field if available. - Default value: true. Possible values: {true, false} - + OQ=Boolean True to restore original qualities from the OQ field to the QUAL field if available. + Default value: true. Possible values: {true, false} + REMOVE_DUPLICATE_INFORMATION=Boolean - Remove duplicate read flags from all reads. Note that if this is true and - REMOVE_ALIGNMENT_INFORMATION==false, the output may have the unusual but sometimes - desirable trait of having unmapped reads that are marked as duplicates. Default value: - true. Possible values: {true, false} - + Remove duplicate read flags from all reads. Note that if this is true and + REMOVE_ALIGNMENT_INFORMATION==false, the output may have the unusual but sometimes + desirable trait of having unmapped reads that are marked as duplicates. Default value: + true. Possible values: {true, false} + REMOVE_ALIGNMENT_INFORMATION=Boolean - Remove all alignment information from the file. Default value: true. TPossible values: {true, false} - - ATTRIBUTE_TO_CLEAR=String When removing alignment information, the set of optional tags to remove. This option may - be specified 0 or more times. - - SANITIZE=Boolean WARNING: This option is potentially destructive. If enabled will discard reads in order - to produce a consistent output BAM. Reads discarded include (but are not limited to) - paired reads with missing mates, duplicated records, records with mismatches in length of - bases and qualities. This option can only be enabled if the output sort order is - queryname and will always cause sorting to occur. Possible values: {true, false} - - MAX_DISCARD_FRACTION=Double If SANITIZE=true and higher than MAX_DISCARD_FRACTION reads are discarded due to - sanitization thenthe program will exit with an Exception instead of exiting cleanly. - Output BAM will still be valid. Default value: 0.01. - + Remove all alignment information from the file. Default value: true. TPossible values: {true, false} + + ATTRIBUTE_TO_CLEAR=String When removing alignment information, the set of optional tags to remove. This option may + be specified 0 or more times. + + SANITIZE=Boolean WARNING: This option is potentially destructive. If enabled will discard reads in order + to produce a consistent output BAM. Reads discarded include (but are not limited to) + paired reads with missing mates, duplicated records, records with mismatches in length of + bases and qualities. This option can only be enabled if the output sort order is + queryname and will always cause sorting to occur. Possible values: {true, false} + + MAX_DISCARD_FRACTION=Double If SANITIZE=true and higher than MAX_DISCARD_FRACTION reads are discarded due to + sanitization thenthe program will exit with an Exception instead of exiting cleanly. + Output BAM will still be valid. Default value: 0.01. + SAMPLE_ALIAS=String - ALIAS=String The sample alias to use in the reverted output file. This will override the existing - sample alias in the file and is used only if all the read groups in the input file have - the same sample alias Default value: null. - + ALIAS=String The sample alias to use in the reverted output file. This will override the existing + sample alias in the file and is used only if all the read groups in the input file have + the same sample alias Default value: null. + LIBRARY_NAME=String - LIB=String The library name to use in the reverted output file. This will override the existing - sample alias in the file and is used only if all the read groups in the input file have - the same sample alias Default value: null. - + LIB=String The library name to use in the reverted output file. This will override the existing + sample alias in the file and is used only if all the read groups in the input file have + the same sample alias Default value: null. + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_SamToFastq.xml --- a/picard_SamToFastq.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_SamToFastq.xml Tue Dec 06 10:04:26 2016 -0500 @@ -5,16 +5,17 @@ $report && ## This is necessary for output dataset detection (see output tags below) - + @java_options@ - + @symlink_element_identifier@ + picard SamToFastq - - INPUT="${inputFile}" - + + INPUT='$inputFile.element_identifier' + #if str( $output_per_rg ) == "true": OUTPUT_PER_RG=true OUTPUT_DIR=. @@ -25,34 +26,34 @@ #elif str( $output_per_rg ) == "false" and str( $interleave ) == "true": FASTQ=INTERLEAVED.fastq #end if - + RE_REVERSE="${re_reverse}" INTERLEAVE="${interleave}" INCLUDE_NON_PF_READS="${include_non_pf_reads}" CLIPPING_ATTRIBUTE="${clipping_attribute}" CLIPPING_ACTION="${clipping_action}" READ1_TRIM="${read1_trim}" - + #if int($read1_max_bases_to_write) > -1: READ1_MAX_BASES_TO_WRITE="${read1_max_bases_to_write}" #end if - + READ2_TRIM="${read2_trim}" - + #if int($read2_max_bases_to_write) > -1: READ2_MAX_BASES_TO_WRITE="${read2_max_bases_to_write}" #end if - + INCLUDE_NON_PRIMARY_ALIGNMENTS="${include_non_primary_alignments}" - - + + VALIDATION_STRINGENCY="${validation_stringency}" QUIET=true VERBOSITY=ERROR - + ]]> - + @@ -65,18 +66,18 @@ - + - - - + + + - + @@ -90,7 +91,7 @@ - + @@ -99,8 +100,8 @@ - - + + **Purpose** @@ -120,71 +121,71 @@ @description@ FASTQ=File - F=File Output fastq file (single-end fastq or, if paired, first end of the pair fastq). + F=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 - F2=File Output fastq file (if paired, second end of the pair fastq). Default value: null. + F2=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) - + UNPAIRED_FASTQ=File - FU=File Output fastq file for unpaired reads; may only be provided in paired-fastq mode Default + FU=File Output fastq file for unpaired reads; may only be provided in paired-fastq mode Default value: null. Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG) - + OUTPUT_PER_RG=Boolean - OPRG=Boolean Output a fastq file per read group (two fastq files per read group if the group is + OPRG=Boolean Output a fastq file per read group (two fastq files per read group if the group is paired). Default value: false. Possible values: {true, false} Cannot be used in conjuction with option(s) SECOND_END_FASTQ (F2) UNPAIRED_FASTQ (FU) FASTQ (F) - + OUTPUT_DIR=File - ODIR=File Directory in which to output the fastq file(s). Used only when OUTPUT_PER_RG is true. - Default value: null. - + ODIR=File Directory in which to output the fastq file(s). Used only when OUTPUT_PER_RG is true. + Default value: null. + RE_REVERSE=Boolean - RC=Boolean Re-reverse bases and qualities of reads with negative strand flag set before writing them - to fastq Default value: true. Possible values: {true, false} - + RC=Boolean Re-reverse bases and qualities of reads with negative strand flag set before writing them + to fastq Default value: true. Possible values: {true, false} + INTERLEAVE=Boolean - INTER=Boolean Will generate an interleaved fastq if paired, each line will have /1 or /2 to describe - which end it came from Default value: false. Possible values: {true, false} - + INTER=Boolean Will generate an interleaved fastq if paired, each line will have /1 or /2 to describe + which end it came from Default value: false. Possible values: {true, false} + INCLUDE_NON_PF_READS=Boolean - NON_PF=Boolean Include non-PF reads from the SAM file into the output FASTQ files. PF means 'passes - filtering'. Reads whose 'not passing quality controls' flag is set are non-PF reads. - Default value: false. Possible values: {true, false} - + NON_PF=Boolean Include non-PF reads from the SAM file into the output FASTQ files. PF means 'passes + filtering'. Reads whose 'not passing quality controls' flag is set are non-PF reads. + Default value: false. Possible values: {true, false} + CLIPPING_ATTRIBUTE=String - CLIP_ATTR=String The attribute that stores the position at which the SAM record should be clipped Default - value: null. - + CLIP_ATTR=String The attribute that stores the position at which the SAM record should be clipped Default + value: null. + CLIPPING_ACTION=String - CLIP_ACT=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. - + CLIP_ACT=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 - R1_TRIM=Integer The number of bases to trim from the beginning of read 1. Default value: 0. - + R1_TRIM=Integer The number of bases to trim from the beginning of read 1. Default value: 0. + READ1_MAX_BASES_TO_WRITE=Integer - R1_MAX_BASES=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. - + R1_MAX_BASES=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 - R2_TRIM=Integer The number of bases to trim from the beginning of read 2. Default value: 0. - + R2_TRIM=Integer The number of bases to trim from the beginning of read 2. Default value: 0. + READ2_MAX_BASES_TO_WRITE=Integer - R2_MAX_BASES=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. - + R2_MAX_BASES=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 + 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. - Possible values: {true, false} - + Possible values: {true, false} + @more_info@ diff -r 08f69add4d06 -r e417b1d6288d picard_SortSam.xml --- a/picard_SortSam.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_SortSam.xml Tue Dec 06 10:04:26 2016 -0500 @@ -12,9 +12,10 @@ #set $output = $outFile #end if @java_options@ + @symlink_element_identifier@ picard SortSam - INPUT="${inputFile}" + INPUT='$inputFile.element_identifier' OUTPUT='${output}' SORT_ORDER="${sort_order}" QUIET=true diff -r 08f69add4d06 -r e417b1d6288d picard_ValidateSamFile.xml --- a/picard_ValidateSamFile.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_ValidateSamFile.xml Tue Dec 06 10:04:26 2016 -0500 @@ -16,7 +16,7 @@ && ##set up input files - + @symlink_element_identifier@ #set $reference_fasta_filename = "localref.fa" #if str( $reference_source.reference_source_selector ) == "history": @@ -30,7 +30,7 @@ picard ValidateSamFile - INPUT="${inputFile}" + INPUT='$inputFile.element_identifier' OUTPUT="${outFile}" MODE="${mode}" diff -r 08f69add4d06 -r e417b1d6288d picard_macros.xml --- a/picard_macros.xml Sun Nov 27 15:11:36 2016 -0500 +++ b/picard_macros.xml Tue Dec 06 10:04:26 2016 -0500 @@ -16,6 +16,10 @@ + +