<tool id="gatk2_base_recalibrator" name="Base Recalibrator" version="@VERSION@.0">
  <description>calculates covariates used to recalibrate base quality scores of reads</description>
  <expand macro="requirements" />
  <macros>
    <import>gatk2_macros.xml</import>
  </macros>
  <command interpreter="python">
    gatk2_wrapper.py
    --stdout "${output_log}"
    -d "-I" "${reference_source.input_bam}" "${reference_source.input_bam.ext}" "gatk_input"
    #if str( $reference_source.input_bam.metadata.bam_index ) != "None":
        -d "" "${reference_source.input_bam.metadata.bam_index}" "bam_index" "gatk_input" ##hardcode galaxy ext type as bam_index
    #end if
    -p '
    @JAR_PATH@
    -T "BaseRecalibrator"
    \$GATK2_SITE_OPTIONS

    ## according to http://www.broadinstitute.org/gatk/guide/article?id=1975
    --num_cpu_threads_per_data_thread \${GALAXY_SLOTS:-8}

    ## we set non standards at every run and the user can choose which ones are preferred
    ## in our select box both standard options (ContextCovariate, CycleCovariate) are selected by default
    --no_standard_covs

    #if $reference_source.reference_source_selector != "history":
        -R "${reference_source.ref_file.fields.path}"
    #end if
    #if str($input_recal) != 'None':
        --BQSR "${input_recal}"
    #end if
    --out "${output_recal}"
    #if str( $covariates ) != "None":
        #for $cov in str( $covariates ).split( ',' ):
            -cov "${cov}"
        #end for
    #end if
   '
    
    #set $snp_dataset_provided = False
    #set $rod_binding_names = dict()
    #for $rod_binding in $rod_bind:
        #if str( $rod_binding.rod_bind_type.rod_bind_type_selector ) == 'custom':
            #set $rod_bind_name = $rod_binding.rod_bind_type.custom_rod_name
        #else
            #set $rod_bind_name = $rod_binding.rod_bind_type.rod_bind_type_selector
        #end if
        #if str( $rod_binding.rod_bind_type.rod_bind_type_selector ) == 'dbsnp':
            #set $snp_dataset_provided = True
        #end if
        #set $rod_binding_names[$rod_bind_name] = $rod_binding_names.get( $rod_bind_name, -1 ) + 1
        -d "--knownSites:${rod_bind_name},%(file_type)s" "${rod_binding.rod_bind_type.input_rod}" "${rod_binding.rod_bind_type.input_rod.ext}" "input_${rod_bind_name}_${rod_binding_names[$rod_bind_name]}"
    #end for
    
    #include source=$standard_gatk_options#
    
    ##start analysis specific options
    #if $analysis_param_type.analysis_param_type_selector == "advanced":
        -p '
        #if $analysis_param_type.default_read_group_type.default_read_group_type_selector == "set":
            --default_read_group "${analysis_param_type.default_read_group_type.default_read_group}"
        #end if
        #if str( $analysis_param_type.default_platform ) != "default":
            --default_platform "${analysis_param_type.default_platform}"
        #end if
        #if str( $analysis_param_type.force_read_group_type.force_read_group_type_selector ) == "set":
            --force_read_group "${analysis_param_type.force_read_group_type.force_read_group}"
        #end if
        #if str( $analysis_param_type.force_platform ) != "default":
            --force_platform "${analysis_param_type.force_platform}"
        #end if
        ${analysis_param_type.exception_if_no_tile}
        #if str( $analysis_param_type.solid_options_type.solid_options_type_selector ) == "set":
            #if str( $analysis_param_type.solid_options_type.solid_recal_mode ) != "default":
                --solid_recal_mode "${analysis_param_type.solid_options_type.solid_recal_mode}" 
            #end if
            #if str( $analysis_param_type.solid_options_type.solid_nocall_strategy ) != "default":
                --solid_nocall_strategy "${analysis_param_type.solid_options_type.solid_nocall_strategy}" 
            #end if
        #end if
        --window_size_nqs "${analysis_param_type.window_size_nqs}"
        --homopolymer_nback "${analysis_param_type.homopolymer_nback}"
        '
    #end if
    #if not $snp_dataset_provided:
        -p '--run_without_dbsnp_potentially_ruining_quality'
    #end if
  </command>
  <inputs>
    <conditional name="reference_source">
      <expand macro="reference_source_selector_param" />
      <when value="cached">
        <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &amp;lt;input_file&amp;gt;">
          <validator type="unspecified_build" />
          <validator type="dataset_metadata_in_data_table" table_name="gatk2_picard_indexes" metadata_name="dbkey" metadata_column="dbkey" message="Sequences are not currently available for the specified build." /> <!-- fixme!!! this needs to be a select -->
        </param>
        <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" >
          <options from_data_table="gatk2_picard_indexes">
            <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/>
          </options>
          <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
        </param>
      </when>
      <when value="history">
        <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &amp;lt;input_file&amp;gt;" />
        <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
          <options>
            <filter type="data_meta" key="dbkey" ref="input_bam" />
          </options>
        </param>
      </when>
    </conditional>
    <param name="input_recal" type="data" format="gatk_report" optional="true" label="Covariates table recalibration file" help="The input covariates table file which enables on-the-fly base quality score recalibration. Enables on-the-fly recalibrate of base qualities. The covariates tables are produced by the BaseQualityScoreRecalibrator tool. Please be aware that one should only run recalibration with the covariates file created on the same input bam(s) (-BQSR,--BQSR &amp;lt;recal_file&amp;gt;)" />

    <param name="covariates" type="select" multiple="True" display="checkboxes" label="Covariates to be used in the recalibration" help="-cov,--covariate &amp;lt;covariate&amp;gt;" >
      <!-- might we want to load the available covariates from an external configuration file, since additional ones can be added to local installs? -->
      <option value="ContextCovariate" selected="true"/>
      <option value="CycleCovariate" selected="true"/>
      <option value="RepeatLengthCovariate" />
      <option value="RepeatUnitCovariate" />
      <option value="RepeatUnitAndLengthCovariate" />
      <!--
      Note: ReadGroupCovariate and QualityScoreCovariate are required covariates and will 
      be added for the user regardless of whether or not they were specified.
      <option value="QualityScoreCovariate" />
      <option value="ReadGroupCovariate" />
      -->
    </param>
    
    <repeat name="rod_bind" title="Known Variants" help="Using data sets of known variants (-knownSites,--knownSites &amp;lt;knownSites&amp;gt;)">
        <conditional name="rod_bind_type">
          <param name="rod_bind_type_selector" type="select" label="Variant Type">
            <option value="dbsnp" selected="True">dbSNP</option>
            <option value="snps">SNPs</option>
            <option value="indels">INDELs</option>
            <option value="mask">Mask</option>
            <option value="custom">Custom</option>
          </param>
          <when value="dbsnp">
              <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="Variant file" />
          </when>
          <when value="snps">
              <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="Variant file" />
          </when>
          <when value="indels">
              <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="Variant file" />
          </when>
          <when value="mask">
              <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="Variant file" />
          </when>
          <when value="custom">
              <param name="custom_rod_name" type="text" value="Unknown" label="Customer's variant file"/>
              <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="Variant file" />
          </when>
        </conditional>
    </repeat>

    <expand macro="gatk_param_type_conditional" />
    
    <conditional name="analysis_param_type">
      <param name="analysis_param_type_selector" type="select" label="Basic or Advanced Analysis options">
        <option value="basic" selected="True">Basic</option>
        <option value="advanced">Advanced</option>
      </param>
      <when value="basic">
        <!-- Do nothing here -->
      </when>
      <when value="advanced">
        <conditional name="default_read_group_type">
          <param name="default_read_group_type_selector" type="select" label="Set default Read Group" help="--default_read_group">
            <option value="default" selected="True">Don't Set</option>
            <option value="set">Set</option>
          </param>
          <when value="default">
            <!-- do nothing here -->
          </when>
          <when value="set">
            <param name="default_read_group" type="text" value="Unknown" label="If a read has no read group then default to the provided String"/>
          </when>
        </conditional>
        <param name="default_platform" type="select" label="Set default Platform" help="--default_platform">
          <option value="default" selected="True">Don't Set</option>
          <option value="illumina">illumina</option>
          <option value="454">454</option>
          <option value="solid">solid</option>
        </param>
        <conditional name="force_read_group_type">
          <param name="force_read_group_type_selector" type="select" label="Force Read Group" help="--force_read_group">
            <option value="default" selected="True">Don't Force</option>
            <option value="set">Force</option>
          </param>
          <when value="default">
            <!-- do nothing here -->
          </when>
          <when value="set">
            <param name="force_read_group" type="text" value="Unknown" label="If provided, the read group ID of EVERY read will be forced to be the provided String."/>
          </when>
        </conditional>
        <param name="force_platform" type="select" label="Force Platform" help="--force_platform">
          <option value="default" selected="True">Don't Force</option>
          <option value="illumina">illumina</option>
          <option value="454">454</option>
          <option value="solid">solid</option>
        </param>
        <param name="exception_if_no_tile" type="boolean" checked="False" truevalue="--exception_if_no_tile" falsevalue="" label="Throw an exception when no tile can be found" help="--exception_if_no_tile"/>
        <conditional name="solid_options_type">
          <param name="solid_options_type_selector" type="select" label="Set SOLiD specific options">
            <option value="default" selected="True">Don't Set</option>
            <option value="set">Set</option>
          </param>
          <when value="default">
            <!-- do nothing here -->
          </when>
          <when value="set">
            <param name="solid_recal_mode" type="select" label="How should we recalibrate solid bases in which the reference was inserted" help="-sMode,--solid_recal_mode &amp;lt;solid_recal_mode&amp;gt;">
              <option value="default" selected="True">Don't set</option>
              <option value="DO_NOTHING">DO_NOTHING</option>
              <option value="SET_Q_ZERO">SET_Q_ZERO</option>
              <option value="SET_Q_ZERO_BASE_N">SET_Q_ZERO_BASE_N</option>
              <option value="REMOVE_REF_BIAS">REMOVE_REF_BIAS</option>
            </param>
            <param name="solid_nocall_strategy" type="select" label="Behavior of the recalibrator when it encounters no calls" help="-solid_nocall_strategy,--solid_nocall_strategy &amp;lt;solid_nocall_strategy&amp;gt;">
              <option value="default" selected="True">Don't set</option>
              <option value="THROW_EXCEPTION">THROW_EXCEPTION</option>
              <option value="LEAVE_READ_UNRECALIBRATED">LEAVE_READ_UNRECALIBRATED</option>
              <option value="PURGE_READ">PURGE_READ</option>
            </param>
          </when>
        </conditional>
        <param name="window_size_nqs" type="integer" value="5" label="Window size used by MinimumNQSCovariate" help="window_size_nqs"/>
        <param name="homopolymer_nback" type="integer" value="7" label="number of previous bases to look at in HomopolymerCovariate" help="-nback,--homopolymer_nback &amp;lt;homopolymer_nback&amp;gt;" />
      </when>
    </conditional>
  </inputs>
  <outputs>
    <data format="gatk_report" name="output_recal" label="${tool.name} on ${on_string} (Covariate File)" />
    <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
  </outputs>
  <tests>
      <test>
          <param name="reference_source_selector" value="history" />
          <param name="ref_file" value="phiX.fasta" ftype="fasta" />
          <param name="input_bam" value="gatk/gatk_indel_realigner/gatk_indel_realigner_out_1.bam" ftype="bam" />
          <param name="rod_bind_type_selector" value="dbsnp" />
          <param name="input_rod" value="gatk/fake_phiX_variant_locations.bed" ftype="bed" />
          <param name="standard_covs" value="True" />
          <param name="covariates" value="ReadGroupCovariate,HomopolymerCovariate,MinimumNQSCovariate,PositionCovariate" />
          <param name="gatk_param_type_selector" value="basic" />
          <param name="analysis_param_type_selector" value="basic" />
          <output name="output_recal" file="gatk/gatk_count_covariates/gatk_count_covariates_out_1.csv" /> 
          <output name="output_log" file="gatk/gatk_count_covariates/gatk_count_covariates_out_1.log.contains" compare="contains" />
      </test>
  </tests>
  <help>
.. class:: warningmark

"This calculation is critically dependent on being able to skip over known variant sites. Please provide a dbSNP ROD or a VCF file containing known sites of genetic variation."
However, if you do not provide this file, the '--run_without_dbsnp_potentially_ruining_quality' flag will be automatically used, and the command will be allowed to run.
  
**What it does**

This walker is designed to work as the first pass in a two-pass processing step. It does a by-locus traversal operating only at sites that are not in dbSNP. We assume that all reference mismatches we see are therefore errors and indicative of poor base quality. This walker generates tables based on various user-specified covariates (such as read group, reported quality score, cycle, and dinucleotide) Since there is a large amount of data one can then calculate an empirical probability of error given the particular covariates seen at this site, where p(error) = num mismatches / num observations The output file is a CSV list of (the several covariate values, num observations, num mismatches, empirical quality score) The first non-comment line of the output file gives the name of the covariates that were used for this calculation.  Note: ReadGroupCovariate and QualityScoreCovariate are required covariates and will be added for the user regardless of whether or not they were specified Note: This walker is designed to be used in conjunction with TableRecalibrationWalker.

For more information on base quality score recalibration using the GATK, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_bqsr_BaseRecalibrator.html&gt;`_.

To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gatk/guide/topic?name=best-practices&gt;`_.

If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gatk/guide/topic?name=faqs&gt;`_.

------

**Inputs**

GenomeAnalysisTK: BaseRecalibrator accepts an aligned BAM input file.


**Outputs**

The output is in CSV format.


Go `here &lt;http://www.broadinstitute.org/gatk/guide/topic?name=intro&gt;`_ for details on GATK file formats.

-------

**Settings**::


 default_read_group                               If a read has no read group then default to the provided String.
 default_platform                                 If a read has no platform then default to the provided String. Valid options are illumina, 454, and solid.
 force_read_group                                 If provided, the read group ID of EVERY read will be forced to be the provided String. This is useful to collapse all data into a single read group.
 force_platform                                   If provided, the platform of EVERY read will be forced to be the provided String. Valid options are illumina, 454, and solid.
 window_size_nqs                                  The window size used by MinimumNQSCovariate for its calculation
 homopolymer_nback                                The number of previous bases to look at in HomopolymerCovariate
 exception_if_no_tile                             If provided, TileCovariate will throw an exception when no tile can be found. The default behavior is to use tile = -1
 solid_recal_mode                                 How should we recalibrate solid bases in whichthe reference was inserted? Options = DO_NOTHING, SET_Q_ZERO, SET_Q_ZERO_BASE_N, or REMOVE_REF_BIAS (DO_NOTHING|SET_Q_ZERO|SET_Q_ZERO_BASE_N|REMOVE_REF_BIAS)
 solid_nocall_strategy                            Defines the behavior of the recalibrator when it encounters no calls in the color space. Options = THROW_EXCEPTION, LEAVE_READ_UNRECALIBRATED, or PURGE_READ (THROW_EXCEPTION|LEAVE_READ_UNRECALIBRATED|PURGE_READ)
 recal_file                                       Filename for the input covariates table recalibration .csv file
 out                                              The output CSV file
 standard_covs                                    Use the standard set of covariates in addition to the ones listed using the -cov argument
 run_without_dbsnp_potentially_ruining_quality    If specified, allows the recalibrator to be used without a dbsnp rod. Very unsafe and for expert users only.

@CITATION_SECTION@
  </help>
  <expand macro="citations" />
</tool>