ensure we never check in autogenerated documentation or build artefacts
[jabaws.git] / runner / compbio / pipeline / _jpred / Jpred4.java
1 /* Copyright (c) 2011 Peter Troshin\r
2  *  \r
3  *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.0     \r
4  * \r
5  *  This library is free software; you can redistribute it and/or modify it under the terms of the\r
6  *  Apache License version 2 as published by the Apache Software Foundation\r
7  * \r
8  *  This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without\r
9  *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache \r
10  *  License for more details.\r
11  * \r
12  *  A copy of the license is in apache_license.txt. It is also available here:\r
13  * @see: http://www.apache.org/licenses/LICENSE-2.0.txt\r
14  * \r
15  * Any republication or derived work distributed in source code form\r
16  * must include this copyright and license notice.\r
17  */\r
18 package compbio.pipeline._jpred;\r
19 \r
20 import java.util.List;\r
21 \r
22 import compbio.data.sequence.FastaSequence;\r
23 \r
24 /**\r
25  * \r
26  * jpred --sequence <fasta file> OR --alignment <clustalW alignment> [--db\r
27  * <database>] [--pred-nohits] [--logLevel=(ERROR|INFO|DEBUG)] [--help]\r
28  * \r
29  * jpred4 --sequence <fasta file> The path to the sequence (in FASTA format) you\r
30  * want to predict OR\r
31  * \r
32  * [--alignment <clustalW alignment>] The alignment which to use for prediction\r
33  * \r
34  * [--profile=<path to HMM profile>]\r
35  * \r
36  * [--db <database>] Database to use for PSI-BLAST querying. Default: uniref90 (\r
37  * /homes/www-jpred/databases/uniref90.filt) Please note that database must be\r
38  * psi-blast indexed\r
39  * \r
40  * [--pred-nohits] Toggle allowing Jpred to make predictions even when there are\r
41  * no PSI-BLAST hits.\r
42  * \r
43  * [--logLevel=(ERROR|INFO|DEBUG)] one of ERROR, INFO, DEBUG [--help]\r
44  * \r
45  * \r
46  * @author pvtroshin\r
47  * \r
48  */\r
49 public class Jpred4 {\r
50 \r
51         List<FastaSequence> readFastaSequence() {\r
52                 return null;\r
53         }\r
54 \r
55         public void runPsiBlast() {\r
56         };\r
57 \r
58 }\r