File: squizz.pod

package info (click to toggle)
squizz 0.99c%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,760 kB
  • ctags: 8,355
  • sloc: sh: 4,789; ansic: 2,640; lex: 1,999; yacc: 1,650; makefile: 119
file content (117 lines) | stat: -rw-r--r-- 2,271 bytes parent folder | download | duplicates (3)
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

=pod

=head1 NAME

=over 4

=item B<squizz> - Sequence format checker

=back

=head1 SYNOPSIS

=over 4

=item B<squizz> [B<-AShlnsv>] [B<-c> F<format>] [B<-f> F<format>]
F<file>

=back

=head1 OPTIONS

Following command line options are allowed:

=over 4

=item -A

Restrict detection/verification to alignment formats (conflict with
B<-S> option).

=item -S

Restrict detection/verification to sequence formats (conflict with
B<-A> option).

=item -c F<format>

Convert detected sequence/alignment into F<format>. This option
implies strict alignment checking.

=item -f F<format>

Assume input format is F<format>. Do not try to detect the format,
just verify that the given one is correct.

=item -h

Display help message and exit.

=item -l

List all supported formats.

=item -n

Count and report detected entries. This option is only available when
the detection is restricted to a single type (with B<-A> or B<-S>
options) and strict checks (without B<-s> option) are enabled.

=item -s

Disable strict format checks (enabled by default).

=item -v

Display version information and exit.

=back

=head1 DESCRIPTION

B<squizz> is a sequence format file checker, but it has some
conversion capabilities too.

B<squizz> can detect the most common sequence and alignment formats :

* B<CODATA>, B<EMBL>, B<FASTA>, B<GCG>, B<GDE>, B<GENBANK>, B<IG>,
B<NBRF> (pir), B<RAW>, and B<SWISSPROT>.

* B<CLUSTAL>, B<FASTA>, B<MSF>, B<NEXUS>, B<PHYLIP> (interleaved and
sequential) and B<STOCKHOLM>.

B<squizz> can do some conversions too, if the format the input format
is supported. Only 3 types are available : sequence to sequence,
alignment to alignment, and alignment to sequence (the last one,
sequence to alignment, require multiple alignments algorithms and
cannot be handled with formatting tools).

Strict format checks validate the previously detected objects, by
making some sanity checks:

=over 4

=item - sequence strings must exists.

=item - alignment is made of more than one sequence.

=item - alignment sequence strings must have the same length.

=item - alignment sequence names must exists, and be unique.

=back

=head1 SEE ALSO

=over 4

=item B<seqfmt>(5), B<alifmt>(5)

=back

=head1 AUTHOR

Nicolas Joly (njoly@pasteur.fr), Institut Pasteur.

=cut