<tool id="plant_tribes_gene_family_aligner" name="GeneFamilyAligner" version="@WRAPPER_VERSION@.2">
    <description>aligns integrated orthologous gene family clusters</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements_gene_family_aligner" />
    <command detect_errors="exit_code"><![CDATA[
#set input_format = $input_format_cond.input_format
#set alignment_method_cond = $input_format_cond.alignment_method_cond
#set alignment_method = $alignment_method_cond.alignment_method
#if str($input_format_cond.input_format) == 'ptortho':
    #set output_codon_alignments = False
#else if str($input_format_cond.input_format) == 'ptorthocs' and str($input_format_cond.codon_alignments ) == 'no':
    #set output_codon_alignments = False
#else:
    #set output_codon_alignments = True
#end if

python '$__tool_directory__/gene_family_aligner.py'
--alignment_method $alignment_method
#if str($alignment_method) == 'pasta':
    --pasta_script_path '$__tool_directory__/run_pasta.py'
    --pasta_iter_limit $alignment_method_cond.pasta_iter_limit
#end if
--num_threads \${GALAXY_SLOTS:-4}
#if str($input_format) == 'ptortho':
    --orthogroup_faa '$input_format_cond.input_ptortho.extra_files_path'
#else:
    ## str($input_format) == 'ptorthocs'
    --orthogroup_faa '$input_format_cond.input_ptorthocs.extra_files_path'
    #if str($input_format_cond.codon_alignments) == 'yes':
        --codon_alignments true
    #end if
#end if
#set remove_gappy_sequences = $remove_gappy_sequences_cond.remove_gappy_sequences
#if str($remove_gappy_sequences) == 'yes':
    #set trim_type_cond = $remove_gappy_sequences_cond.trim_type_cond
    #set trim_type = $trim_type_cond.trim_type
    #if str($trim_type) == 'gap_trimming' and str($trim_type_cond.gap_trimming):
        --gap_trimming $trim_type_cond.gap_trimming
    #else:
        ## str($trim_type) == 'automated_trimming'
        --automated_trimming true
    #end if
    #set remove_sequences_with_gaps_cond = $remove_gappy_sequences_cond.remove_sequences_with_gaps_cond
    #set remove_sequences_with_gaps = $remove_sequences_with_gaps_cond.remove_sequences_with_gaps
    #if str($remove_sequences_with_gaps) == 'yes':
        #if str($remove_sequences_with_gaps_cond.remove_sequences_with_gaps_of):
            --remove_sequences $remove_sequences_with_gaps_cond.remove_sequences_with_gaps_of
        #end if
        #if str($remove_sequences_with_gaps_cond.iterative_realignment):
            --iterative_realignment $remove_sequences_with_gaps_cond.iterative_realignment
        #end if
        #if $output_codon_alignments:
            --output '$output_aln_filtered_ca'
            --output_dir '$output_aln_filtered_ca.files_path'
        #else:
            --output '$output_aln_filtered'
            --output_dir '$output_aln_filtered.files_path'
        #end if
    #else:
        #if $output_codon_alignments:
            --output '$output_aln_trimmed_ca'
            --output_dir '$output_aln_trimmed_ca.files_path'
        #else:
            --output '$output_aln_trimmed'
            --output_dir '$output_aln_trimmed.files_path'
        #end if
    #end if
#else:
    #if $output_codon_alignments:
        --output '$output_aln_ca'
        --output_dir '$output_aln_ca.files_path'
    #else:
        --output '$output_aln'
        --output_dir '$output_aln.files_path'
    #end if
#end if
#if str($output_dataset_collection) == 'yes':
    --output_dataset_collection dataset_collection
#end if
    ]]></command>
    <inputs>
        <conditional name="input_format_cond">
            <param name="input_format" type="select" label="Classified orthogroup fasta files">
                <option value="ptortho">Proteins orthogroup fasta files</option>
                <option value="ptorthocs">Protein and coding sequences orthogroup fasta files</option>
            </param>
            <when value="ptortho">
                <param name="input_ptortho" format="ptortho" type="data" label="Proteins orthogroup fasta files">
                    <validator type="empty_extra_files_path" />
                </param>
                <expand macro="cond_alignment_method" />
            </when>
            <when value="ptorthocs">
                <param name="input_ptorthocs" format="ptorthocs" type="data" label="Protein and coding sequences orthogroup fasta files">
                    <validator type="empty_extra_files_path" />
                </param>
                <expand macro="cond_alignment_method" />
                <expand macro="param_codon_alignments" />
            </when>
        </conditional>
        <expand macro="cond_remove_gappy_sequences" />
        <param name="output_dataset_collection" type="select" display="radio" label="Output additional dataset collection of files?">
            <option value="no" selected="true">No</option>
            <option value="yes">Yes</option>
        </param>
    </inputs>
    <outputs>
        <data name="output_aln" format="ptalign" label="${tool.name} (proteins orthogroup alignments) on ${on_string}">
            <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'no')) and remove_gappy_sequences_cond['remove_gappy_sequences'] == 'no'</filter>
        </data>
        <data name="output_aln_ca" format="ptalignca" label="${tool.name} (protein and coding sequences orthogroup alignments) on ${on_string}">
            <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'yes')) and remove_gappy_sequences_cond['remove_gappy_sequences'] == 'no'</filter>
        </data>
        <data name="output_aln_filtered" format="ptalignfiltered" label="${tool.name} (filtered proteins orthogroup alignments) on ${on_string}">
            <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'no')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'yes')</filter>
        </data>
        <data name="output_aln_filtered_ca" format="ptalignfilteredca" label="${tool.name} (filtered protein and coding sequences orthogroup alignments) on ${on_string}">
            <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'yes')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'yes')</filter>
        </data>
        <data name="output_aln_trimmed" format="ptaligntrimmed" label="${tool.name} (trimmed proteins orthogroup alignments) on ${on_string}">
            <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'no')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'no')</filter>
        </data>
        <data name="output_aln_trimmed_ca" format="ptaligntrimmedca" label="${tool.name} (trimmed protein and coding sequences orthogroup alignments) on ${on_string}">
            <filter>(input_format_cond['input_format'] == 'ptortho' or (input_format_cond['input_format'] == 'ptorthocs' and input_format_cond['codon_alignments'] == 'yes')) and (remove_gappy_sequences_cond['remove_gappy_sequences'] == 'yes' and remove_gappy_sequences_cond['remove_sequences_with_gaps_cond']['remove_sequences_with_gaps'] == 'no')</filter>
        </data>
        <collection name="dataset_collection" type="list" label="${tool.name} (dataset collection) on ${on_string}">
            <discover_datasets pattern="__name__" directory="dataset_collection" format="fasta" />
            <filter>output_dataset_collection == 'yes'</filter>
        </collection>
    </outputs>
    <tests>
        <!-- Test framework does not currently support inputs whose associated extra_files_path contains files to be analyzed.
        <test>
        </test>
        -->
    </tests>
    <help>
This tool is one of the PlantTribes collection of automated modular analysis pipelines for comparative and evolutionary
analyses of genome-scale gene families and transcriptomes. This tool estimates protein and codon multiple sequence alignments
of integrated orthologous gene family fasta files produced by the GeneFamilyIntegrator tool.

-----

**Required options**

 * **Classified orthogroup fasta files** - orthogroup fasta files produced by the GeneFamilyClassifier tool selected from your history.  Depending on how the GeneFamilyClassifier tool was executed, these could either be proteins or proteins and their corresponding coding sequences.

 * **Multiple sequence alignment method** - method for estimating orthogroup multiple sequence alignments.  PlantTribes estimates alignments using either MAFFT's L-INS-i algorithm or the divide and conquer approach implemented in the PASTA pipeline for large alignments.

  - **PASTA iteration limit** - number of PASTA iterations. By default, PASTA performs 3 iterations.

 * **Codon alignments** - select 'Yes' to create codon multiple sequence alignments.  This option requires protein and their corresponding coding sequences to be provided as input data.

**Other options**

 * **Alignment post-processing configuration** - select 'Yes' to enable multiple sequence alignment post-processing configuration options.

  - **Trimming method** - multiple sequence alignment trimming method.  PlantTribes trims alignments using two automated approaches implemented in trimAl.  Gap score based trimming removes alignments sites that do not achieve a user specified gap score.  For example, a setting of 0.1 removes sites that have gaps in 90% or more of the sequences in the multiple sequence alignment.  The automated heuristic trimming approach determines the best automated trimAl method to trim a given alignment as described in the trimAl tutorial `trimAl`_.

    - **Gap score** - the fraction of sequences with gap allowed in an alignment site.  The score is restricted to the range 0.0 - 1.0.  Zero value has no effect.

  - **Remove sequences** - select 'Yes' to remove sequences in multiple sequence alignments that do not achieve a user specified alignment coverage score.  For example, a setting of 0.7 removes sequences with more than 30% gaps in the alignment.  This option requires one of the trimming methods to be set.

    - **Coverage score** - minimum fraction of sites without gaps for a sequence in a multiple sequence alignment.  The score is restricted to the range 0.0 - 1.0.  Zero value has no effect.

    - **Realignment iteration limit** - number of iterations to perform trimming, removal of sequences, and realignment of orthogroup sequences.  Zero value has no effect.

 * **Output additional dataset collection of files** - selecting 'Yes' will produce an additional output dataset collection whose elements are copies of the directories of files (these elements can be viewed with visualization tools).

.. _trimAl: http://trimal.cgenomics.org

    </help>
    <citations>
        <expand macro="citation1" />
        <citation type="bibtex">
            @article{Wall2008,
            journal = {Nucleic Acids Research},
            author = {2. Wall PK, Leebens-Mack J, Muller KF, Field D, Altman NS},
            title = {PlantTribes: a gene and gene family resource for comparative genomics in plants},
            year = {2008},
            volume = {36},
            number = {suppl 1},
            pages = {D970-D976},}
        </citation>
        <citation type="bibtex">
            @article{Katoh2013,
            journal = {Molecular biology and evolution},
            author = {3. Katoh K, Standley DM},
            title = {MAFFT multiple sequence alignment software version 7: improvements in performance and usability},
            year = {2013},
            volume = {30},
            number = {4},
            pages = {772-780},}
        </citation>
        <citation type="bibtex">
            @article{Mirarab2014,
            journal = {Research in Computational Molecular Biology (RECOMB)},
            author = {4. Mirarab S, Nguyen N, Warnow T},
            title = {PASTA: Ultra-Large Multiple Sequence Alignment. In R. Sharan (Ed.)},
            year = {2014},
            pages = {177–191},
            url = {https://github.com/smirarab/pasta},}
        </citation>
        <citation type="bibtex">
            @article{Capella-Gutierrez2009,
            journal = {Bioinformatics,},
            author = {5. Capella-Gutierrez S, Silla-Martínez JM, Gabaldón T},
            title = {trimAl: a tool for automated alignment trimming in large-scale phylogenetic analyses},
            year = {2009},
            volume = {25},
            number = {15},
            pages = {1972-1973},}
        </citation>
        <citation type="bibtex">
            @article{Yachdav2016,
            journal = {Bioinformatics,},
            author = {6. Yachdav G, Wilzbach S, Rauscher B, Sheridan R, Sillitoe I, Procter J, Lewis SE, Rost B, Goldberg T},
            title = {MSAViewer: interactive JavaScript visualization of multiple sequence alignments},
            year = {2016},
            volume = {32},
            number = {22},
            pages = {3501-3503},}
        </citation>
        <citation type="bibtex">
            @article{Clamp2004,
            journal = {Bioinformatics,},
            author = {7. Clamp M, Cuff J, Searle SM, Barton GJ},
            title = {The jalview java alignment editor},
            year = {2004},
            volume = {20},
            number = {3},
            pages = {426-427},}
        </citation>
    </citations>
</tool>