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

<pise>

<head>
<title>CPGPLOT</title>
<description>Plot CpG rich areas (EMBOSS)</description>
<category>nucleic:cpg islands</category>
<doclink>http://bioweb.pasteur.fr/docs/EMBOSS/cpgplot.html</doclink>
</head>

<command>cpgplot</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 -- DNA [sequences] (-sequence)</prompt>
		<format>
			<language>perl</language>
			<code>" -sequence=$value -sformat=fasta"</code>
		</format>
		<group>1</group>
		<seqtype><value>dna</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>required</name>
	<prompt>Required section</prompt>

<parameters>
	<parameter type="Integer" ismandatory="1" issimple="1" ishidden="0">
	<name>window</name>
	<attributes>
		<prompt>Window size (-window)</prompt>
		<vdef>
			<value>100</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>" -window=$value"</code>
		</format>
		<group>2</group>
		<comment>
			<value>The percentage CG content and the Observed frequency of CG is calculated within a window whose size is set by this parameter. The window is moved down the sequence and these statistics are calculated at each postition that the window is moved to.</value>
		</comment>
		<scalemin><value>1</value></scalemin>
		<scalemax>
			<language>acd</language>
			<code>$sequence.end</code>
		</scalemax>
	</attributes>
	</parameter>

	<parameter type="Integer" ismandatory="1" issimple="1" ishidden="0">
	<name>shift</name>
	<attributes>
		<prompt>Window shift increment (-shift)</prompt>
		<vdef>
			<value>1</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>" -shift=$value"</code>
		</format>
		<group>3</group>
		<comment>
			<value>This determines the number of bases that the window is moved each time after values of the percentage CG content and the Observed frequency of CG are calculated within the window.</value>
		</comment>
		<scalemin><value>1</value></scalemin>
		<scalemax>
			<language>acd</language>
			<code>$window</code>
		</scalemax>
	</attributes>
	</parameter>

	<parameter type="Integer" ismandatory="1" issimple="1" ishidden="0">
	<name>minlen</name>
	<attributes>
		<prompt>Minimum length of an island (-minlen)</prompt>
		<vdef>
			<value>200</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>" -minlen=$value"</code>
		</format>
		<group>4</group>
		<comment>
			<value>This sets the minimum length that a CpG island has to be before it is reported.</value>
		</comment>
		<scalemin><value>1</value></scalemin>
		<scalemax>
			<language>acd</language>
			<code>$sequence.end</code>
		</scalemax>
	</attributes>
	</parameter>

	<parameter type="Float" ismandatory="1" issimple="1" ishidden="0">
	<name>minoe</name>
	<attributes>
		<prompt>Minimum observed/expected (-minoe)</prompt>
		<vdef>
			<value>0.6</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>" -minoe=$value"</code>
		</format>
		<group>5</group>
		<comment>
			<value>This sets the minimum average observed to expected ratio of C plus G to CpG in a set of 10 windows that are required before a CpG island is reported.</value>
		</comment>
		<scalemin><value>0.</value></scalemin>
		<scalemax><value>10.</value></scalemax>
	</attributes>
	</parameter>

	<parameter type="Float" ismandatory="1" issimple="1" ishidden="0">
	<name>minpc</name>
	<attributes>
		<prompt>Minimum percentage (-minpc)</prompt>
		<vdef>
			<value>50.</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>" -minpc=$value"</code>
		</format>
		<group>6</group>
		<comment>
			<value>This sets the minimum average percentage of G plus C a set of 10 windows that are required before a CpG island is reported.</value>
		</comment>
		<scalemin><value>0.</value></scalemin>
		<scalemax><value>100.</value></scalemax>
	</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>outfile</name>
	<attributes>
		<prompt>outfile (-outfile)</prompt>
		<vdef><value>outfile.out</value></vdef>
		<format>
			<language>perl</language>
			<code>" -outfile=$value"</code>
		</format>
		<group>7</group>
		<comment>
			<value>This sets the name of the file holding the report of the input sequence name, CpG island parameters and the output details of any CpG islands that are found.</value>
		</comment>
	</attributes>
	</parameter>

	<parameter type="Excl" ismandatory="1" issimple="1" ishidden="0">
	<name>graph</name>
	<attributes>
		<prompt>graph (-graph)</prompt>
			<vlist>
				<value>x11</value>
				<label>x11</label>
				<value>hp7470</value>
				<label>hp7470</label>
				<value>postscript</value>
				<label>postscript</label>
				<value>cps</value>
				<label>cps</label>
				<value>hp7580</value>
				<label>hp7580</label>
				<value>null</value>
				<label>null</label>
				<value>data</value>
				<label>data</label>
				<value>colourps</value>
				<label>colourps</label>
				<value>text</value>
				<label>text</label>
				<value>none</value>
				<label>none</label>
				<value>tek4107t</value>
				<label>tek4107t</label>
				<value>tekt</value>
				<label>tekt</label>
				<value>xwindows</value>
				<label>xwindows</label>
				<value>hpgl</value>
				<label>hpgl</label>
				<value>xterm</value>
				<label>xterm</label>
				<value>meta</value>
				<label>meta</label>
				<value>ps</value>
				<label>ps</label>
				<value>tek</value>
				<label>tek</label>
				<value>png</value>
				<label>png</label>
				<value>tektronics</value>
				<label>tektronics</label>
			</vlist>
		<vdef><value>postscript</value></vdef>
		<format>
			<language>perl</language>
			<code>" -graph=$value"</code>
		</format>
		<group>8</group>
	</attributes>
	</parameter>

	<parameter type="Switch" ismandatory="0" issimple="0" ishidden="0">
	<name>obsexp</name>
	<attributes>
		<prompt>Show observed/expected threshold line (-obsexp)</prompt>
		<vdef>
			<value>1</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>($value)? "" : " -noobsexp"</code>
		</format>
		<group>9</group>
		<comment>
			<value>If this is set to true then the graph of the observed to expected ratio of C plus G to CpG within a window is displayed.</value>
		</comment>
	</attributes>
	</parameter>

	<parameter type="Switch" ismandatory="0" issimple="0" ishidden="0">
	<name>cg</name>
	<attributes>
		<prompt>Show CpG rich regions (-cg)</prompt>
		<vdef>
			<value>1</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>($value)? "" : " -nocg"</code>
		</format>
		<group>10</group>
		<comment>
			<value>If this is set to true then the graph of the regions which have been determined to be CpG islands is displayed.</value>
		</comment>
	</attributes>
	</parameter>

	<parameter type="Switch" ismandatory="0" issimple="0" ishidden="0">
	<name>pc</name>
	<attributes>
		<prompt>Show percentage line (-pc)</prompt>
		<vdef>
			<value>1</value>
		</vdef>
		<format>
			<language>perl</language>
			<code>($value)? "" : " -nopc"</code>
		</format>
		<group>11</group>
		<comment>
			<value>If this is set to true then the graph of the percentage C plus G within a window is displayed.</value>
		</comment>
	</attributes>
	</parameter>

	<parameter type="OutFile" ismandatory="1" issimple="1" ishidden="0">
	<name>featout</name>
	<attributes>
		<prompt>featout -- nucleotide (-featout)</prompt>
		<vdef><value>featout.out</value></vdef>
		<format>
			<language>perl</language>
			<code>" -featout=$value"</code>
		</format>
		<group>12</group>
		<comment>
			<value>File for output features</value>
		</comment>
	</attributes>
	</parameter>


	<parameter type="Excl">
		<name>featout_offormat</name>
		<attributes>
			<prompt>Feature output format (-offormat)</prompt>
			<format>
				<language>perl</language>
				<code>($value)? " -offormat=$value" : "" </code>
			</format>
			<vlist>
				<value>embl</value>
				<label>embl</label>
				<value>gff</value>
				<label>gff</label>
				<value>swiss</value>
				<label>swiss</label>
				<value>pir</value>
				<label>pir</label>
				<value>nbrf</value>
				<label>nbrf</label>
			</vlist>
			<vdef><value>gff</value></vdef>
			<group>12</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>13</group>
</attributes>
</parameter>
<parameter type="Results">
<name>psresults_graph</name>
<attributes>
	<precond>
		<language>perl</language>
		<code>$graph eq "postscript" || $graph eq "ps" || $graph eq "colourps" || $graph eq "cps"</code>
	</precond>
	<filenames>*.ps</filenames>
</attributes>
</parameter>
<parameter type="Results">
<name>metaresults_graph</name>
<attributes>
	<precond>
		<language>perl</language>
		<code>$graph eq "meta"</code>
	</precond>
	<filenames>*.meta</filenames>
</attributes>
</parameter>
<parameter type="Results">
<name>dataresults_graph</name>
<attributes>
	<precond>
		<language>perl</language>
		<code>$graph eq "data"</code>
	</precond>
	<filenames>*.dat</filenames>
</attributes>
</parameter>
<parameter type="Results">
<name>pngresults_graph</name>
<attributes>
	<precond>
		<language>perl</language>
		<code>$graph eq "png"</code>
	</precond>
	<filenames>*.png *.2 *.3</filenames>
</attributes>
</parameter>
<parameter type="Results">
<name>hpglresults_graph</name>
<attributes>
	<precond>
		<language>perl</language>
		<code>$graph =~ /hp/</code>
	</precond>
	<filenames>*.hpgl</filenames>
</attributes>
</parameter>

</parameters>
</pise>
