<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE pise SYSTEM "PARSER/pise.dtd" [
<!ENTITY emboss_init SYSTEM "XMLDIR/emboss.xml">
]>

<pise>

<head>
<title>CONS</title>
<description>Creates a consensus from multiple alignments (EMBOSS)</description>
<category>alignment:consensus</category>
<doclink>http://bioweb.pasteur.fr/docs/EMBOSS/cons.html</doclink>
</head>

<command>cons</command>

<parameters>

&emboss_init;


<parameter type="Paragraph">
<paragraph>
<name>input</name>
	<prompt>Input section</prompt>

<parameters>
	<parameter type="Sequence" ismandatory="1" issimple="1" ishidden="0">
	<name>sequence</name>
	<attributes>
		<prompt>sequence -- gapany [set of sequences] (-sequence)</prompt>
		<format>
			<language>perl</language>
			<code>" -sequence=$value -sformat=fasta"</code>
		</format>
		<group>1</group>
		<comment>
			<value>File containing a sequence alignment.</value>
		</comment>
		<seqtype><value>gapany</value></seqtype>
		<seqfmt>
			<value>8</value>
		</seqfmt>
		<pipe>
			<pipetype>seqsfile</pipetype>
				<language>perl</language>
				<code>1</code>
		</pipe>
	</attributes>
	</parameter>

	</parameters>
</paragraph>
</parameter>


<parameter type="Paragraph">
<paragraph>
<name>advanced</name>
	<prompt>Advanced section</prompt>

<parameters>
	<parameter type="Excl" ismandatory="0" issimple="0" ishidden="0">
	<name>datafile</name>
	<attributes>
		<prompt>Scoring matrix (-datafile)</prompt>
			<vlist>
				<value>EPAM60</value>
				<label>EPAM60</label>
				<value>EPAM290</value>
				<label>EPAM290</label>
				<value>EPAM470</value>
				<label>EPAM470</label>
				<value>EPAM110</value>
				<label>EPAM110</label>
				<value>EBLOSUM50</value>
				<label>EBLOSUM50</label>
				<value>EPAM220</value>
				<label>EPAM220</label>
				<value>EBLOSUM62-12</value>
				<label>EBLOSUM62-12</label>
				<value>EPAM400</value>
				<label>EPAM400</label>
				<value>EPAM150</value>
				<label>EPAM150</label>
				<value>EPAM330</value>
				<label>EPAM330</label>
				<value>EBLOSUM55</value>
				<label>EBLOSUM55</label>
				<value>EPAM30</value>
				<label>EPAM30</label>
				<value>EPAM260</value>
				<label>EPAM260</label>
				<value>EBLOSUM90</value>
				<label>EBLOSUM90</label>
				<value>EPAM440</value>
				<label>EPAM440</label>
				<value>EPAM190</value>
				<label>EPAM190</label>
				<value>EPAM370</value>
				<label>EPAM370</label>
				<value>EPAM70</value>
				<label>EPAM70</label>
				<value>EPAM480</value>
				<label>EPAM480</label>
				<value>EPAM120</value>
				<label>EPAM120</label>
				<value>EDNAMAT</value>
				<label>EDNAMAT</label>
				<value>EPAM300</value>
				<label>EPAM300</label>
				<value>EBLOSUM60</value>
				<label>EBLOSUM60</label>
				<value>EPAM230</value>
				<label>EPAM230</label>
				<value>EBLOSUM62</value>
				<label>EBLOSUM62</label>
				<value>EPAM410</value>
				<label>EPAM410</label>
				<value>EPAM160</value>
				<label>EPAM160</label>
				<value>EPAM340</value>
				<label>EPAM340</label>
				<value>EBLOSUM65</value>
				<label>EBLOSUM65</label>
				<value>EPAM40</value>
				<label>EPAM40</label>
				<value>EPAM270</value>
				<label>EPAM270</label>
				<value>EPAM450</value>
				<label>EPAM450</label>
				<value>EPAM380</value>
				<label>EPAM380</label>
				<value>EPAM80</value>
				<label>EPAM80</label>
				<value>EPAM490</value>
				<label>EPAM490</label>
				<value>EBLOSUM30</value>
				<label>EBLOSUM30</label>
				<value>EBLOSUMN</value>
				<label>EBLOSUMN</label>
				<value>EPAM200</value>
				<label>EPAM200</label>
				<value>EPAM130</value>
				<label>EPAM130</label>
				<value>EBLOSUM35</value>
				<label>EBLOSUM35</label>
				<value>EPAM310</value>
				<label>EPAM310</label>
				<value>EBLOSUM70</value>
				<label>EBLOSUM70</label>
				<value>EPAM10</value>
				<label>EPAM10</label>
				<value>EPAM240</value>
				<label>EPAM240</label>
				<value>EPAM420</value>
				<label>EPAM420</label>
				<value>EPAM170</value>
				<label>EPAM170</label>
				<value>EBLOSUM75</value>
				<label>EBLOSUM75</label>
				<value>EPAM350</value>
				<label>EPAM350</label>
				<value>EPAM280</value>
				<label>EPAM280</label>
				<value>EPAM50</value>
				<label>EPAM50</label>
				<value>EPAM460</value>
				<label>EPAM460</label>
				<value>EPAM390</value>
				<label>EPAM390</label>
				<value>EPAM90</value>
				<label>EPAM90</label>
				<value>EPAM100</value>
				<label>EPAM100</label>
				<value>EBLOSUM40</value>
				<label>EBLOSUM40</label>
				<value>EPAM210</value>
				<label>EPAM210</label>
				<value>EPAM140</value>
				<label>EPAM140</label>
				<value>EBLOSUM45</value>
				<label>EBLOSUM45</label>
				<value>EPAM320</value>
				<label>EPAM320</label>
				<value>EBLOSUM80</value>
				<label>EBLOSUM80</label>
				<value>EPAM500</value>
				<label>EPAM500</label>
				<value>EPAM20</value>
				<label>EPAM20</label>
				<value>EPAM250</value>
				<label>EPAM250</label>
				<value>EPAM430</value>
				<label>EPAM430</label>
				<value>EPAM180</value>
				<label>EPAM180</label>
				<value>EBLOSUM85</value>
				<label>EBLOSUM85</label>
				<value>EPAM360</value>
				<label>EPAM360</label>
			</vlist>
		<format>
			<language>perl</language>
			<code>($value)? " -datafile=$value" : ""</code>
		</format>
		<group>2</group>
		<comment>
			<value>This is the scoring matrix file used when comparing sequences. By default it is the file 'EBLOSUM62' (for proteins) or the file 'EDNAFULL' (for nucleic sequences). These files are found in the 'data' directory of the EMBOSS installation.</value>
		</comment>
	</attributes>
	</parameter>

	<parameter type="Float" ismandatory="0" issimple="0" ishidden="0">
	<name>plurality</name>
	<attributes>
		<prompt>Plurality check value (-plurality)</prompt>
		<vdef>
			<language>acd</language>
			<code>@( $(sequence.totweight) / 2)</code>
		</vdef>
		<format>
			<language>perl</language>
			<code>(defined $value &amp;&amp; $value != $vdef)? " -plurality=$value" : ""</code>
		</format>
		<group>3</group>
		<comment>
			<value>Set a cut-off for the number of positive matches below which there is no consensus. The default plurality is taken as half the total weight of all the sequences in the alignment.</value>
		</comment>
	</attributes>
	</parameter>

	<parameter type="Integer" ismandatory="0" issimple="0" ishidden="0">
	<name>identity</name>
	<attributes>
		<prompt>Required number of identities at a position (-identity)</prompt>
		<vdef>
			<value>0</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>(defined $value &amp;&amp; $value != $vdef)? " -identity=$value" : ""</code>
		</format>
		<group>4</group>
		<comment>
			<value>Provides the facility of setting the required number of identities at a site for it to give a consensus at that position. Therefore, if this is set to the number of sequences in the alignment only columns of identities contribute to the consensus.</value>
		</comment>
	</attributes>
	</parameter>

	<parameter type="Float" ismandatory="0" issimple="0" ishidden="0">
	<name>setcase</name>
	<attributes>
		<prompt>Define a threshold above which the consensus is given in uppercase (-setcase)</prompt>
		<vdef>
			<language>acd</language>
			<code>@( $(sequence.totweight) / 2)</code>
		</vdef>
		<format>
			<language>perl</language>
			<code>(defined $value &amp;&amp; $value != $vdef)? " -setcase=$value" : ""</code>
		</format>
		<group>5</group>
		<comment>
			<value>Sets the threshold for the positive matches above which the consensus is is upper-case and below which the consensus is in lower-case.</value>
		</comment>
	</attributes>
	</parameter>

	</parameters>
</paragraph>
</parameter>


<parameter type="Paragraph">
<paragraph>
<name>output</name>
	<prompt>Output section</prompt>

<parameters>
	<parameter type="OutFile" ismandatory="1" issimple="1" ishidden="0">
	<name>outseq</name>
	<attributes>
		<prompt>outseq (-outseq)</prompt>
		<vdef><value>outseq.out</value></vdef>
		<format>
			<language>perl</language>
			<code>" -outseq=$value"</code>
		</format>
		<group>6</group>
		<pipe>
			<pipetype>seqfile</pipetype>
				<language>perl</language>
				<code>1</code>
		</pipe>
	</attributes>
	</parameter>

	<parameter type="Excl" issimple="1">
	<name>outseq_sformat</name>
	<attributes>
		<prompt>Output format for: outseq</prompt>
		<vlist>
			<value>fasta</value>
			<label>fasta</label>
			<value>gcg</value>
			<label>gcg</label>
			<value>phylip</value>
			<label>phylip</label>
			<value>embl</value>
			<label>embl</label>
			<value>swiss</value>
			<label>swiss</label>
			<value>ncbi</value>
			<label>ncbi</label>
			<value>nbrf</value>
			<label>nbrf</label>
			<value>genbank</value>
			<label>genbank</label>
			<value>ig</value>
			<label>ig</label>
			<value>codata</value>
			<label>codata</label>
			<value>strider</value>
			<label>strider</label>
			<value>acedb</value>
			<label>acedb</label>
			<value>staden</value>
			<label>staden</label>
			<value>text</value>
			<label>text</label>
			<value>fitch</value>
			<label>fitch</label>
			<value>msf</value>
			<label>msf</label>
			<value>clustal</value>
			<label>clustal</label>
			<value>phylip</value>
			<label>phylip</label>
			<value>phylip3</value>
			<label>phylip3</label>
			<value>asn1</value>
			<label>asn1</label>
		</vlist>
		<vdef><value>fasta</value></vdef>
		<format>
			<language>perl</language>
			<code>" -osformat=$value"</code>
		</format>
		<group>7</group>
	</attributes>
	</parameter>
	<parameter type="String" ismandatory="0" issimple="0" ishidden="0">
	<name>name</name>
	<attributes>
		<prompt>Name of the consensus sequence (-name)</prompt>
		<format>
			<language>perl</language>
			<code>($value)? " -name=$value" : ""</code>
		</format>
		<group>8</group>
	</attributes>
	</parameter>

	</parameters>
</paragraph>
</parameter>

<parameter type="String" ishidden="1">
<name>auto</name>
<attributes>
	<format>
		<language>perl</language>
		<code>" -auto -stdout"</code>
	</format>
	<group>9</group>
</attributes>
</parameter>

</parameters>
</pise>
