File: libscan.html

package info (click to toggle)
emboss 6.6.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 571,248 kB
  • ctags: 39,971
  • sloc: ansic: 460,578; java: 29,439; perl: 13,573; sh: 12,740; makefile: 3,275; csh: 706; asm: 351; xml: 239; pascal: 237; modula3: 8
file content (1154 lines) | stat: -rw-r--r-- 34,590 bytes parent folder | download | duplicates (9)
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
<!--START OF HEADER - DON'T ALTER -->

<HTML>
<HEAD>
  <TITLE>
  EMBOSS: libscan
  </TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" text="#000000">



<table align=center border=0 cellspacing=0 cellpadding=0>
<tr><td valign=top>
<A HREF="/" ONMOUSEOVER="self.status='Go to the EMBOSS home page';return true"><img border=0 src="/images/emboss_icon.jpg" alt="" width=150 height=48></a>
</td>
<td align=left valign=middle>
<b><font size="+6">

libscan
</font></b>
</td></tr>
</table>
<br>&nbsp;
<p>



<!--END OF HEADER-->






<H2>
    Function
</H2>
Scans a database with a set of models that represents a family

<!--
DON'T WRITE ANYTHING HERE.
IT IS DONE FOR YOU.
-->




<H2>
    Description
</H2>

<!-- 
	This is the main part of the document.
        This is what the user looks at to find out if this program will do what he wants. 
        Long description.
        Why it is useful.
        When it should/shouldn't be used.
  -->

Scans each signature, profile or HMM in a directory against a sequence
database and writes a signature hits file for each one. Or scans sequences
against such a library of discriminating elements and writes a library scan
file for each one. 

<p>

This program is part of a suite of EMBOSS applications that directly or
indirectly make use of the protein structure databases pdb and scop.
This program is part of an experimental analysis pipeline described in an
accompanying document.  We provide the software in the hope that it will
be useful.  The applications were designed for specific research purposes
and may not be useful or reliable in contexts other than the described
pipeline.  The development of the suite was coordinated by Jon Ison to
whom enquiries and bug reports should be sent (email jison@hgmp.mrc.ac.uk).

<p>

The advantage of screening a relatively small library of discriminating
elements with a sequence is that it is sufficient for the sequence to
detect its true family (discriminator) in the first rank for an effective
prediction.  This is in contrast to searching a larger sequence database to
identify homology, where biologically significant hits may achieve
statistically insignificant scores and therefore be missed.  A library
might help the detection of such proteins because they may still score
their true discriminator higher than the others in the library regardless
of statistical estimates.  Further improvements to predictions are gained
when multiple sources of evidence, in this case the different types of
discriminating element, are considered.

<p>

The libscan application allows a protein sequence or sequences to be
screened against the library of discriminating elements.  The results of a
screen are returned to the user in a library scan file containing a list
of top-scoring SCOP domains rank-ordered by p-value for each individual
type of discriminator, and also for all of the discriminator types in
combination (combined prediction).  For the combined prediction, the
p-value is derived from an empirically derived distribution of the product
of the p-values of the individual methods.    

<p>

libscan runs in one of two modes either (i) database search mode or (ii)
library screen mode. In database search mode libscan reads one or more
directories each containing a single type of discriminating element, the
permitted types are sparse sequence signature, Gribskov profile, Henikoff
profile or hidden Markov model.  Each directory must contain a
discriminating element for each of one or more scop families; files for
indivdual families should have the same name (possibly with different file
extensions) in the different directories, e.g. the scop family with the
identifier 46445 might be represented by files 46445.hmm, 46445.sig,
46445.gribs and 46445.henik in their respective directories.  libscan scans
each discriminating element against a sequence set that must also be
provided by the user and generates a signature hits file (of scored hits
to sequences in the set) for each individual discriminating element.  In
mode (i), the user must also provide a scop validation file so that a
classification of hits can be given in the signature hits files.  The user
specifies a maximum number of false hits that are written to the signature
hits files.

<p>

In library screen mode, libscan
reads a sequence set, screens each sequence against the library
(directories of discriminating elements) and writes a library scan file
(of top-scoring families) for each sequence.  In either mode, a scop
classification file is required as a source of family classification data.
The paths and extensions of the sequence set and scop classification files
(input) different types of discriminating elements (input), and paths and
extension of signature hits files or library scan file (output) are
specified by the user.       












<H2>
    Algorithm
</H2>

<!-- 
        Algorithms
	  Pseudocode/Vague description/Handwaving/web links to useful pages
  -->



The approach for calculating p-values for individual discriminator-sequence
matches is the same irrespective of which mode libscan is run in and is
summarised as follows: (i) Each discriminating element is scanned (scored)
against each sequence.  (ii) The ditribution of scores is generated for
each different type of element.  (iii) Using these distributions, a p-value
is calculated for each discriminator-sequence match.
The approach for calculating the 'combined p-value' for each individual
sequence is as follows: (i) p-values of the matches for the different types
of discriminator versus a sequence are multiplied to yield the 'product of
p-values'.  (ii) A distribution of 'product of p-values' is generated for
each individual sequence.  (iii) Using these distributions, a so-called
'combined p-value', reflecting the overall significance of the matches of
the sequence to the different types of discriminators, is generated.
Importantly, two (or more) p-values are only ever multiplied together if
corresponding hit is to the same region of the protein.  'Same' is defined
as two hits overlapping by a user-defined number of residues. 










<H2>
    Usage
</H2>

<!--  
	Example usage, as run from the command-line.
        Many examples illustrating different behaviours is good.
 -->





<H2>
    Command line arguments
</H2>

<table CELLSPACING=0 CELLPADDING=3 BGCOLOR="#f5f5ff" ><tr><td>
<pre>
   Standard (Mandatory) qualifiers (* if not always prompted):
   -mode               menu       Libscan runs in one of two modes either (i)
                                  database search mode or (ii) library screen
                                  mode. In database search mode libscan reads
                                  one or more directories each containing a
                                  single type of discriminating element, the
                                  permitted types are sparse sequence
                                  signature, Gribskov profile, Henikoff
                                  profile or hidden Markov model. In library
                                  screen mode, libscan reads a sequence set,
                                  screens each sequence against the library
                                  (directories of discriminating elements) and
                                  writes a library scan file (of top-scoring
                                  families) for each one.
   -db                 seqset     In database search mode libscan scans each
                                  discriminating element against a sequence
                                  set. In library screen mode, libscan reads a
                                  sequence set and screens each sequence
                                  against the library (directories of
                                  disciminating elements)
   -[no]grib           boolean    Use Gribskov profile
   -[no]henik          boolean    Use Henikoff profile
   -[no]hmm            boolean    Use HMM profile
   -[no]sig            boolean    Use signature
*  -hmmpath            string     Location of HMM profile files (input)
*  -hmmextn            string     Extension of HMM profile files (input)
*  -hmmoutpath         string     Location of signature hits/library scan
                                  files for hmm searches (output)
*  -hmmoutextn         string     Extension of signature hits/library scan
                                  files for hmm searches (output)
*  -gbvpath            string     Location of Gribskov profile files (input)
*  -gbvextn            string     Extension of Gribskov profile files (input)
*  -gbvgapo            float      Gap insertion penalty
*  -gbvgape            float      Gap extension penalty
*  -gbvoutpath         string     Location of signature hits/library scan
                                  files for Gribskov profile searches (output)
*  -gbvoutextn         string     Extension of signature hits/library scan
                                  files for Gribskov profile searches (output)
*  -hnfpath            string     Location of Hennikoff profile files (input)
*  -hnfextn            string     Extension of Hennikoff profile files (input)
*  -hnfgapo            float      Gap insertion penalty
*  -hnfgape            float      Gap extension penalty
*  -hnfoutpath         string     Location of signature hits/library scan
                                  files for Henikoff profile searches (output)
*  -hnfoutextn         string     Extension of signature hits/library scan
                                  files for Henikoff profile searches (output)
*  -sigpath            string     Location of signature files (input)
*  -sigextn            string     Extension of signature files (input)
*  -nterm              menu       Select number
*  -sub                matrixf    Residue substitution matrix
*  -siggapo            float      Gap insertion penalty
*  -siggape            float      Gap extension penalty
*  -sigoutpath         string     Location of signature hits/library scan
                                  files for signature searches (output)
*  -sigoutextn         string     Extension for signature hits/library scan
                                  files for signature searches (output)
   -scopf              infile     In either mode, a 'scop classification file'
                                  is required as a source of family
                                  classification data. A scop classification
                                  file contains classification and other data
                                  for domains from the scop database. The file
                                  is in embl-like format and is generated by
                                  scopparse. Domain sequence information can
                                  be added to the file by using scopseqs.
*  -targetf            infile     A 'scop validation file' contains sequence
                                  relatives (hits) for each of a number of
                                  different scop families, superfamilies and
                                  folds. The file contains the collated
                                  results from psiblast searches of a sequence
                                  database for the indvidual scop families;
                                  hits of unambiguous family assignment are
                                  listed under their respective family,
                                  otherwise a hit is assigned as relatives to
                                  a scop superfamily or fold instead. The scop
                                  validation file is generated by seqnr and
                                  is in embl-like format.
*  -maxhits            integer    The maximum number of hits to be written to
                                  the signature hits file.
*  -overlap            integer    When estimating the statistical significance
                                  of scored matches of different types of
                                  discriminating element to a sequence, two
                                  (or more) p-values are only ever multiplied
                                  together if corresponding hit is to the same
                                  region of the protein. 'Same' is defined as
                                  two hits overlapping by a user-defined
                                  number of residues.
   -mrgoutpath         string     Location of signature hits / library scan
                                  files for merged results (output)
   -mrgoutextn         string     Extension for signature hits / library scan
                                  files for merged results (output)

   Additional (Optional) qualifiers: (none)
   Advanced (Unprompted) qualifiers: (none)
   Associated qualifiers:

   "-db" associated qualifiers
   -sbegin              integer    Start of each sequence to be used
   -send                integer    End of each sequence to be used
   -sreverse            boolean    Reverse (if DNA)
   -sask                boolean    Ask for begin/end/reverse
   -snucleotide         boolean    Sequence is nucleotide
   -sprotein            boolean    Sequence is protein
   -slower              boolean    Make lower case
   -supper              boolean    Make upper case
   -sformat             string     Input sequence format
   -sdbname             string     Database name
   -sid                 string     Entryname
   -ufo                 string     UFO features
   -fformat             string     Features format
   -fopenfile           string     Features file name

   General qualifiers:
   -auto                boolean    Turn off prompts
   -stdout              boolean    Write standard output
   -filter              boolean    Read standard input, write standard output
   -options             boolean    Prompt for standard and additional values
   -debug               boolean    Write debug output to program.dbg
   -verbose             boolean    Report some/full command line options
   -help                boolean    Report command line options. More
                                  information on associated and general
                                  qualifiers can be found with -help -verbose
   -warning             boolean    Report warnings
   -error               boolean    Report errors
   -fatal               boolean    Report fatal errors
   -die                 boolean    Report deaths


</pre>
</td></tr></table>
<P>
<table border cellspacing=0 cellpadding=3 bgcolor="#ccccff">
<tr bgcolor="#FFFFCC">
<th align="left" colspan=2>Standard (Mandatory) qualifiers</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>

<tr>
<td>-mode</td>
<td>Libscan runs in one of two modes either (i) database search mode or (ii) library screen mode. In database search mode libscan reads one or more directories each containing a single type of discriminating element, the permitted types are sparse sequence signature, Gribskov profile, Henikoff profile or hidden Markov model. In library screen mode, libscan reads a sequence set, screens each sequence against the library (directories of discriminating elements) and writes a library scan file (of top-scoring families) for each one.</td>
<td><table><tr><td>1</td> <td><i>(Database search mode)</i></td></tr><tr><td>2</td> <td><i>(Library screen mode)</i></td></tr></table></td>
<td>1</td>
</tr>

<tr>
<td>-db</td>
<td>In database search mode libscan scans each discriminating element against a sequence set. In library screen mode, libscan reads a sequence set and screens each sequence against the library (directories of disciminating elements)</td>
<td>Readable set of sequences</td>
<td><b>Required</b></td>
</tr>

<tr>
<td>-[no]grib</td>
<td>Use Gribskov profile</td>
<td>Boolean value Yes/No</td>
<td>Yes</td>
</tr>

<tr>
<td>-[no]henik</td>
<td>Use Henikoff profile</td>
<td>Boolean value Yes/No</td>
<td>Yes</td>
</tr>

<tr>
<td>-[no]hmm</td>
<td>Use HMM profile</td>
<td>Boolean value Yes/No</td>
<td>Yes</td>
</tr>

<tr>
<td>-[no]sig</td>
<td>Use signature</td>
<td>Boolean value Yes/No</td>
<td>Yes</td>
</tr>

<tr>
<td>-hmmpath</td>
<td>Location of HMM profile files (input)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-hmmextn</td>
<td>Extension of HMM profile files (input)</td>
<td>Any string is accepted</td>
<td>.hmm</td>
</tr>

<tr>
<td>-hmmoutpath</td>
<td>Location of signature hits/library scan files for hmm searches (output)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-hmmoutextn</td>
<td>Extension of signature hits/library scan files for hmm searches (output)</td>
<td>Any string is accepted</td>
<td>.hmmout</td>
</tr>

<tr>
<td>-gbvpath</td>
<td>Location of Gribskov profile files (input)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-gbvextn</td>
<td>Extension of Gribskov profile files (input)</td>
<td>Any string is accepted</td>
<td>.gribs</td>
</tr>

<tr>
<td>-gbvgapo</td>
<td>Gap insertion penalty</td>
<td>Any numeric value</td>
<td>1.0</td>
</tr>

<tr>
<td>-gbvgape</td>
<td>Gap extension penalty</td>
<td>Any numeric value</td>
<td>1.0</td>
</tr>

<tr>
<td>-gbvoutpath</td>
<td>Location of signature hits/library scan files for Gribskov profile searches (output)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-gbvoutextn</td>
<td>Extension of signature hits/library scan files for Gribskov profile searches (output)</td>
<td>Any string is accepted</td>
<td>.gribout</td>
</tr>

<tr>
<td>-hnfpath</td>
<td>Location of Hennikoff profile files (input)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-hnfextn</td>
<td>Extension of Hennikoff profile files (input)</td>
<td>Any string is accepted</td>
<td>.henik</td>
</tr>

<tr>
<td>-hnfgapo</td>
<td>Gap insertion penalty</td>
<td>Any numeric value</td>
<td>1.0</td>
</tr>

<tr>
<td>-hnfgape</td>
<td>Gap extension penalty</td>
<td>Any numeric value</td>
<td>1.0</td>
</tr>

<tr>
<td>-hnfoutpath</td>
<td>Location of signature hits/library scan files for Henikoff profile searches (output)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-hnfoutextn</td>
<td>Extension of signature hits/library scan files for Henikoff profile searches (output)</td>
<td>Any string is accepted</td>
<td>.henikout</td>
</tr>

<tr>
<td>-sigpath</td>
<td>Location of signature files (input)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-sigextn</td>
<td>Extension of signature files (input)</td>
<td>Any string is accepted</td>
<td>.sig</td>
</tr>

<tr>
<td>-nterm</td>
<td>Select number</td>
<td><table><tr><td>1</td> <td><i>(Align anywhere and allow only complete signature-sequence fit)</i></td></tr><tr><td>2</td> <td><i>(Align anywhere and allow partial signature-sequence fit)</i></td></tr><tr><td>3</td> <td><i>(Use empirical gaps only)</i></td></tr></table></td>
<td>1</td>
</tr>

<tr>
<td>-sub</td>
<td>Residue substitution matrix</td>
<td>Comparison matrix file in EMBOSS data path</td>
<td>EBLOSUM62</td>
</tr>

<tr>
<td>-siggapo</td>
<td>Gap insertion penalty</td>
<td>Any numeric value</td>
<td>10.0</td>
</tr>

<tr>
<td>-siggape</td>
<td>Gap extension penalty</td>
<td>Any numeric value</td>
<td>0.5</td>
</tr>

<tr>
<td>-sigoutpath</td>
<td>Location of signature hits/library scan files for signature searches (output)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-sigoutextn</td>
<td>Extension for signature hits/library scan files for signature searches (output)</td>
<td>Any string is accepted</td>
<td>.sigout</td>
</tr>

<tr>
<td>-scopf</td>
<td>In either mode, a 'scop classification file' is required as a source of family classification data. A scop classification file contains classification and other data for domains from the scop database. The file is in embl-like format and is generated by scopparse. Domain sequence information can be added to the file by using scopseqs.</td>
<td>Input file</td>
<td><b>Required</b></td>
</tr>

<tr>
<td>-targetf</td>
<td>A 'scop validation file' contains sequence relatives (hits) for each of a number of different scop families, superfamilies and folds. The file contains the collated results from psiblast searches of a sequence database for the indvidual scop families; hits of unambiguous family assignment are listed under their respective family, otherwise a hit is assigned as relatives to a scop superfamily or fold instead. The scop validation file is generated by seqnr and is in embl-like format.</td>
<td>Input file</td>
<td><b>Required</b></td>
</tr>

<tr>
<td>-maxhits</td>
<td>The maximum number of hits to be written to the signature hits file.</td>
<td>Any integer value</td>
<td>50</td>
</tr>

<tr>
<td>-overlap</td>
<td>When estimating the statistical significance of scored matches of different types of discriminating element to a sequence, two (or more) p-values are only ever multiplied together if corresponding hit is to the same region of the protein. 'Same' is defined as two hits overlapping by a user-defined number of residues.</td>
<td>Any integer value</td>
<td>10</td>
</tr>

<tr>
<td>-mrgoutpath</td>
<td>Location of signature hits / library scan files for merged results (output)</td>
<td>Any string is accepted</td>
<td>./</td>
</tr>

<tr>
<td>-mrgoutextn</td>
<td>Extension for signature hits / library scan files for merged results (output)</td>
<td>Any string is accepted</td>
<td>.mrgout</td>
</tr>

<tr bgcolor="#FFFFCC">
<th align="left" colspan=2>Additional (Optional) qualifiers</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>

<tr>
<td colspan=4>(none)</td>
</tr>

<tr bgcolor="#FFFFCC">
<th align="left" colspan=2>Advanced (Unprompted) qualifiers</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>

<tr>
<td colspan=4>(none)</td>
</tr>

</table>


<!--
DON'T WRITE ANYTHING HERE.
IT IS DONE FOR YOU.
-->








<H2>
    Input file format
</H2>

<!-- 
        This includes example input file formats.
        This should be a detailed description and example - assume
        someone will want to parse this file and will want to know what
        happens in unusual cases - null input, etc. 
   -->

<b>libscan</b> reads any normal sequence USAs.

<p>



<p>

The format of the scop classification file is described in scopparse

<p>

The format of the signature files is explained in siggen

<p>

The format of the profile and hmm files is explained in documentation for
the propechy application and the hmmer package respectively. 



<H2>
    Output file format
</H2>

<!-- 
        This includes example output file formats.
        This should be a detailed description and example - assume
        someone will want to parse this file and will want to know what
        happens in unusual cases - null output, errors etc. 

        If you wish to include the standard description of the avalable
	report formats, use:
<p>

The output is a standard EMBOSS report file. 

<p>

The results can be output in one of several styles by using the
command-line qualifier <b>-rformat xxx</b>, where 'xxx' is replaced by
the name of the required format.  The available format names are: embl,
genbank, gff, pir, swiss, trace, listfile, dbmotif, diffseq, excel,
feattable, motif, regions, seqtable, simple, srs, table, tagseq

<p>

See:
<A href="http://emboss.sf.net/docs/themes/ReportFormats.html">
http://emboss.sf.net/docs/themes/ReportFormats.html</A>
for further information on report formats.

<p>

   -->



<p>



<p>

The format of the signature hits file is described in sigscan



<H2>
    Data files
</H2>

<!-- 
        Any data files used (e.g. translation table file)
        This includes example data file formats if they are
        not obvious.

	If you wish to include the standard description of what data
	files are and how to use embossdata to inspect and retrieve
	them, use:
   -->

<p>
EMBOSS data files are distributed with the application and stored
in the standard EMBOSS data directory, which is defined
by the EMBOSS environment variable EMBOSS_DATA.

<p>

To see the available EMBOSS data files, run:
<p>
<pre>
% embossdata -showall
</pre>
<p>
To fetch one of the data files (for example 'Exxx.dat') into your
current directory for you to inspect or modify, run:

<pre>

% embossdata -fetch -file Exxx.dat

</pre>
<p>

Users can provide their own data files in their own directories.
Project specific files can be put in the current directory, or for
tidier directory listings in a subdirectory called
".embossdata". Files for all EMBOSS runs can be put in the user's home
directory, or again in a subdirectory called ".embossdata".

<p>
The directories are searched in the following order:

<ul>
   <li> . (your current directory)
   <li> .embossdata (under your current directory)
   <li> ~/ (your home directory)
   <li> ~/.embossdata
</ul>
<p>


<p>

libscan requires a residue substitution matrix.













<H2>
    Notes
</H2>

<!-- 
        Restrictions.
        Interesting behaviour.
        Useful things you can do with this program.
   -->

None.







<H2>
    References
</H2>

<!-- 
        Bibliography for methods used.
   -->

None.








<H2>
    Warnings
</H2>

<!-- 
        Potentially stupid things the program will let you do.
   -->

The score distributions and therefore p-values are calculated only from the
data that libscan is provided.  Therefore, meaningful p-values are only
guaranteed if the sequence set (database search mode) or number of families
(library screeen mode) is sufficiently large. 







<H2>
    Diagnostic Error Messages
</H2>

<!-- 
        Error messages specific to this program, eg:
        "FATAL xxx" - means you have not set up the xxx data using program <b>prog</b>.<p>
   -->

None.







<H2>
    Exit status
</H2>

<!-- 
        Description of the exit status for various error conditions
   -->

It always exits with status 0.








<H2>
    Known bugs
</H2>


<!-- 
        Bugs noted but not yet fixed.
   -->

None.








<!--
<H2>
    See also
</H2>
-->
<h2><a name="See also">See also</a></h2>
<table border cellpadding=4 bgcolor="#FFFFF0">
<tr><th>Program name</th><th>Description</th></tr>
<tr><td><a href="contacts.html">contacts</a></td><td>Reads coordinate files and writes files of intra-chain residue-residue contact data</td></tr>
<tr><td><a href="fraggle.html">fraggle</a></td><td>Removes fragment sequences from files of hits for scop families</td></tr>
<tr><td><a href="hmmgen.html">hmmgen</a></td><td>Generates a hidden Markov model for each alignment in a directory by using the HMMER package</td></tr>
<tr><td><a href="interface.html">interface</a></td><td>Reads coordinate files and writes files of inter-chain residue-residue contact data</td></tr>
<tr><td><a href="profgen.html">profgen</a></td><td>Generates various profiles for each alignment in a directory</td></tr>
<tr><td><a href="rocplot.html">rocplot</a></td><td>Provides interpretation and graphical display of the performance of discriminating elements (e.g. profiles for protein families). rocplot reads file(s) of hits from discriminator-database search(es), performs ROC analysis on the hits, and writes graphs illustrating the diagnostic performance of the discriminating elements</td></tr>
<tr><td><a href="scopalign.html">scopalign</a></td><td>Generate alignments for families in a scop classification file by using STAMP</td></tr>
<tr><td><a href="scoprep.html">scoprep</a></td><td>Reorder scop classificaiton file so that the representative structure of each family is given first</td></tr>
<tr><td><a href="scopreso.html">scopreso</a></td><td>Removes low resolution domains from a scop classification file</td></tr>
<tr><td><a href="seqalign.html">seqalign</a></td><td>Generate extended alignments for families in a scop families file by using CLUSTALW with seed alignments</td></tr>
<tr><td><a href="seqsearch.html">seqsearch</a></td><td>Generate files of hits for families in a scop classification file by using PSI-BLAST with seed alignments</td></tr>
<tr><td><a href="seqsort.html">seqsort</a></td><td>Reads multiple files of hits and writes (i) a scop families file and (ii) a scop ambiguities file</td></tr>
<tr><td><a href="seqwords.html">seqwords</a></td><td>Generate file of hits for scop families by searching swissprot with keywords</td></tr>
<tr><td><a href="siggen.html">siggen</a></td><td>Generates a sparse protein signature from an alignment and residue contact data</td></tr>
<tr><td><a href="sigplot.html">sigplot</a></td><td>Generates data files of signature performance</td></tr>
<tr><td><a href="sigscan.html">sigscan</a></td><td>Scans a signature against swissprot and writes a signature hits file</td></tr>
</table>

<!-- 
        Add any comments about other associated programs (to prepare
        data files?) that seealso doesn't find. 
   -->


<p>

Hidden Markov models can be generated for scop families by using hmmgen
which uses the HMMER package.

<p>

Simple frequency matrices, Gribskov profiles and Hennikoff profiles can be
generated for scop families by using profgen.

<p>

A 'signature file' contains a sparse sequence signature.  The files are
generated by siggen.

<p>

A 'signature hits file' contains the results of a search of a
discriminating element (one of protein signature, hidden Markov model,
simple frequency matrix, Gribskov profile or Hennikoff profile) against a
sequence database.  The files are generated by sigscan and modelscan.

<p>

A 'library scan file' holds the results of a search of a sequence against a
library of discriminating elements for scop families (one directory for
each type of element, e.g. sparse sequence signatures, profiles or HMMs).

<p>

The library scan file contains, for each invividual type of discriminating
element and for the combination of the elements, classification and other
data for each of a user-defined number of top-scoring families
(discriminators) from the scop database.

<p>

A 'scop classification file' contains classification and other data for
domains from the scop database.  The file is in embl-like format and is
generated by scopparse.  Domain sequence information can be added to the
file by using scopseqs.

<p>

A 'scop validation file' contains sequence relatives (hits) for each of a
number of different scop families, superfamilies and folds.  The file
contains the collated results from psiblast searches of a sequence database
for the indvidual scop families; hits of unambiguous family assignment are
listed under their respective family, otherwise a hit is assigned as
relatives to a scop superfamily or fold instead.  The scop validation file
is generated by seqnr and is in embl-like format. 







<H2>
    Author(s)
</H2>
<!--
        Who has worked on the program in the past.
e.g. one of:
Alan Bleasby (ableasby&nbsp;&copy;&nbsp;rfcgr.mrc.ac.uk)
<br>
MRC Rosalind Franklin Centre for Genomics Research
Wellcome Trust Genome Campus, Hinxton, Cambridge, CB10 1SB, UK


Bernd Jagla (bernd&nbsp;&copy;&nbsp;golgi.ski.mskcc.org)
<br>
Cellular Biochemistry and Biophysics Program, Rockefeller
Research Laboratories, Memorial Sloan-Kettering Cancer Center, 1275 York
Avenue, Box 251,New York, NY 10021.

David Martin (dmartin&nbsp;&copy;&nbsp;rfcgr.mrc.ac.uk)
<br>

Gos Micklem (gos&nbsp;&copy;&nbsp;ebi.ac.uk)
<br>
Informatics Division, European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK

Gary Williams (gwilliam&nbsp;&copy;&nbsp;rfcgr.mrc.ac.uk)
<br>
MRC Rosalind Franklin Centre for Genomics Research
Wellcome Trust Genome Campus, Hinxton, Cambridge, CB10 1SB, UK


Ian Longden (il&nbsp;&copy;&nbsp;sanger.ac.uk)
<br>
Sanger Institute, Wellcome Trust Genome Campus, Hinxton,
Cambridge, CB10 1SA, UK.                      

Mark Faller (current e-mail address unknown)
<br>
while he was with:
<br>
HGMP-RC, Genome Campus, Hinxton, Cambridge CB10 1SB, UK

Michael K. Schuster and Martin Grabner (martin.grabner&nbsp;&copy;&nbsp;univie.ac.at)
<br>
from the Austrian National EMBnet node.


Michael Schmitz (mschmitz&nbsp;&copy;&nbsp;lbl.gov)
<br>
Lawrence Berkeley Labs, USA

Nicolas Tourasse (nicolas.tourasse&nbsp;&copy;&nbsp;biotek.uio.no)
<br>
Biotechnology Center of Oslo

Peter Rice (pmr&nbsp;&copy;&nbsp;ebi.ac.uk)
<br>
Informatics Division, European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK

Richard Durbin (rd&nbsp;&copy;&nbsp;sanger.ac.uk)
<br>
Sanger Institute, Wellcome Trust Genome Campus, Hinxton,
Cambridge, CB10 1SA, UK.                      

Richard Bruskiewich (r.bruskiewich@cgiar.org)
<br>
while he was at:
<br>
Sanger Institute, Wellcome Trust Genome Campus, Hinxton,
Cambridge, CB10 1SA, UK.                      

Rodrigo Lopez (rls&nbsp;&copy;&nbsp;ebi.ac.uk)
<br>
European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK

Sinead O'Leary (current e-mail address unknown)
<br>
while she was at:
<br>
HGMP-RC, Genome Campus, Hinxton, Cambridge CB10 1SB, UK


Tim Carver (tcarver&nbsp;&copy;&nbsp;rfcgr.mrc.ac.uk)
<br>
MRC Rosalind Franklin Centre for Genomics Research
Wellcome Trust Genome Campus, Hinxton, Cambridge, CB10 1SB, UK

Thomas Laurent (thomas.laurent&nbsp;&copy;&nbsp;uk.lionbioscience.com)
<br>
Lion Bioscience Ltd,
     Compass House,
     80-82 Newmarket Road,
     Cambridge,
     CB5 8DZ,
     UK

Val Curwen (vac&nbsp;&copy;&nbsp;sanger.ac.uk)
<br>
Sanger Institute, Wellcome Trust Genome Campus, Hinxton,
Cambridge, CB10 1SA, UK. 


   -->


Jon Ison (jison&nbsp;&copy;&nbsp;rfcgr.mrc.ac.uk)
<br>
MRC Rosalind Franklin Centre for Genomics Research
Wellcome Trust Genome Campus, Hinxton, Cambridge, CB10 1SB, UK



<p>

Ranjeeva Ranasinghe (rranasin&nbsp;&copy;&nbsp;hgmp.mrc.ac.uk)
<br>
HGMP-RC, Genome Campus, Hinxton, Cambridge CB10 1SB, UK











<H2>
    History
</H2>

<!--
        What changes have been made.
   -->

Written (2003) - Jon Ison & Ranjeeva Ranasinghe

<!--
<p>


-->












<H2>
    Target users
</H2>

<!--
        For general users, requested by one user, for EMBOSS site
        maintainers, for EMBOSS developers etc.
        eg:
        "This program is intended to be used by everyone and everything,
        from naive users to embedded scripts." 
	Which is easy to include using:
   -->

This program is intended to be used by everyone and everything, from naive users to embedded scripts.












</BODY>
</HTML>