File: glam2scan.1.xml

package info (click to toggle)
glam2 1064-9
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 956 kB
  • sloc: ansic: 6,925; xml: 757; asm: 74; makefile: 54; sh: 11
file content (182 lines) | stat: -rw-r--r-- 5,892 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/xsl"
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
	"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- Process this file with an XSLT processor, e.g. xsltproc:    -->
<!-- `xsltproc \
      -''-nonet \
      -''-param man.charmap.use.subset "0" \
      -''-param make.year.ranges "1" \
      -''-param make.single.year.ranges "1" \
      manpage.xml'                                               -->

  <!ENTITY dhfirstname "Charles">
  <!ENTITY dhsurname   "Plessy">
  <!ENTITY dhemail     "plessy@debian.org">
  <!ENTITY dhusername  "&dhfirstname; &dhsurname;">
  <!ENTITY dhrelease   "1056">
  <!ENTITY dhtitle     "glam2 Manual">
  <!ENTITY dhucpackage "GLAM2SCAN">
  <!ENTITY dhpackage   "glam2scan">
  <!ENTITY dhproduct   "GLAM2">
  <!ENTITY dhsection   "1">

]>

<refentry>
	<refentryinfo>
		<title>&dhtitle;</title>
		<!-- Better put a suite name instead of &dhpackage; into productname -->
		<productname>&dhproduct;</productname>
		<releaseinfo role="version">&dhrelease;</releaseinfo>
		<authorgroup>
			<author>
				<firstname>Martin</firstname>
        <firstname>C</firstname>
				<surname>Frith</surname>
				<contrib>Author of GLAM2.</contrib>
			</author>
			<author>
        <firstname>Timothy</firstname>
        <firstname>L</firstname>
        <surname>Bailey</surname>
        <contrib>Author of GLAM2.</contrib>
      </author>
      <author>
				<firstname>&dhfirstname;</firstname>
				<surname>&dhsurname;</surname>
				<contrib>Formatted this manpage in DocBook XML for the Debian distribution.</contrib>
				<address>
					<email>&dhemail;</email>
				</address>
			</author>
		</authorgroup>
		<legalnotice>
			<para>The source code and the documentation of GLAM2 are released in the public domain.</para>
		</legalnotice>
	</refentryinfo>
	<refmeta>
		<refentrytitle>&dhucpackage;</refentrytitle>
		<manvolnum>&dhsection;</manvolnum>
	</refmeta>
	<refnamediv>
		<refname>&dhpackage;</refname>
		<refpurpose>finds a GLAM2 motif in a database</refpurpose>
	</refnamediv>
	<refsynopsisdiv>
		<cmdsynopsis>
			<command>&dhpackage;</command>
			<arg choice="opt"><option>options</option></arg>
			<arg choice="plain"><option>alphabet</option></arg>
			<arg choice="plain"><replaceable>my_motif.glam2</replaceable></arg>
     	<arg choice="plain"><replaceable>my_seqs.fa</replaceable></arg>
		</cmdsynopsis>
    <para>An alphabet other than <parameter>p</parameter> or <parameter>n</parameter> is interpreted as the name of an alphabet file.</para>
	</refsynopsisdiv>
  
	<refsect1 id="description">
		<title>DESCRIPTION</title>
		<para>
      <command>glam2scan</command> finds matches, in a sequence database, to a motif discovered by <command>glam2</command>. Each match receives a score, indicating how well it fits the motif.
    </para>
	</refsect1>
  
	<refsect1 id="options">
		<title>OPTIONS (default settings)</title>
		<variablelist>
			<!-- Use the variablelist.term.separator and the
			     variablelist.term.break.after parameters to
			     control the term elements. -->
			<varlistentry>
				<term><option>-h</option></term>
				<listitem>
					<para>Show all options and their default settings.</para>
				</listitem>
			</varlistentry>
      
			<varlistentry>
				<term><option>-o</option></term>
				<listitem>
					<para>Output file (<parameter>stdout</parameter>).</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-n</option></term>
				<listitem>
					<para>Number of alignments to report (<parameter>25</parameter>).</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-2</option></term>
				<listitem>
					<para>Examine both strands - forward and reverse complement.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-D</option></term>
				<listitem>
					<para>Deletion pseudocount (<parameter>0.1</parameter>).</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-E</option></term>
				<listitem>
					<para>No-deletion pseudocount (<parameter>2.0</parameter>).</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-I</option></term>
				<listitem>
					<para>Insertion pseudocount (<parameter>0.02</parameter>).</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-J</option></term>
				<listitem>
					<para>No-insertion pseudocount (<parameter>1.0</parameter>).</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-d</option></term>
				<listitem>
					<para>Dirichlet mixture file.</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</refsect1>

	<refsect1 id="see_also">
		<title>SEE ALSO</title>
		<!-- In alpabetical order. -->
		<para><citerefentry>
				<refentrytitle>glam2format</refentrytitle>
				<manvolnum>1</manvolnum>
			</citerefentry>, <citerefentry>
				<refentrytitle>glam2mask</refentrytitle>
				<manvolnum>1</manvolnum>
			</citerefentry>, <citerefentry>
				<refentrytitle>glam2-purge</refentrytitle>
				<manvolnum>1</manvolnum>
			</citerefentry>, <citerefentry>
				<refentrytitle>glam2</refentrytitle>
				<manvolnum>1</manvolnum>
			</citerefentry></para>
		<para>The full Hypertext documentation of GLAM2 is available online at <ulink url="http://bioinformatics.org.au/glam2/">http://bioinformatics.org.au/glam2/</ulink> or on this computer in <filename class="directory">/usr/share/doc/glam2/</filename>.</para>
	</refsect1>
  
  <refsect1 id="ref">
    <title>REFERENCE</title>
    <para>
      If you use GLAM2, please cite: MC Frith, NFW Saunders, B Kobe, TL Bailey (2008) Discovering sequence motifs with arbitrary insertions and deletions, PLoS Computational Biology (in press).
    </para>
  </refsect1>
</refentry>