63947b1a208c477f41cdbf4dda7013d14be5e41d
[jabaws.git] / webservices / compbio / ws / client / client_help.txt
1 \r
2 JABAWS client v2.0 June 2011 http://www.compbio.dundee.ac.uk/jabaws \r
3  \r
4 Usage: <Class or Jar file name> -h=host_and_context <-s=serviceName> ACTION [OPTIONS] \r
5 \r
6 -h=<host_context>  - a full URL to the JABAWS web server including context \r
7                      path e.g. http://10.31.1.159:8080/ws\r
8 -s=<ServiceName>   - one of [MafftWS, MuscleWS, ClustalWS, TcoffeeWS, ProbconsWS, \r
9                      AAConWS, JronnWS, DisemblWS, GlobPlotWS, IUPredWS]\r
10                      <serviceName> is required for all ACTIONS but -list_services\r
11 \r
12 ACTIONS: \r
13 -list_services    - list available services\r
14 -test             - test service \r
15 -i=<inputFile>    - full path to fasta formatted sequence file, from which to align \r
16                     sequences\r
17 -parameters       - lists parameters supported by web service\r
18 -presets          - lists presets supported by web service\r
19 -limits           - lists web services limits\r
20 \r
21 Please note that if input file is specified other actions are ignored\r
22 \r
23 OPTIONS (only for use with -i action):\r
24 -r=<presetName>   - name of the preset to use\r
25 -o=<outputFile>   - full path to the file where to write an alignment\r
26 -f=<PrmInputFile> - the name of the file with the list of parameters to use.\r
27 \r
28 Please note that -r and -f options cannot be used together. Alignment is done with \r
29 either preset or a parameters from the file, but not both!\r
30 \r
31 EXAMPLES: \r
32 \r
33 1) List all available services on the host \r
34 \r
35 Jws2Client -h=http://www.compbio.dundee.ac.uk/jabaws -list_services\r
36 \r
37 2) Test Clustal web service \r
38 \r
39 Jws2Client -h=http://www.compbio.dundee.ac.uk/jabaws -s=ClustalWS -test \r
40 \r
41 3) Align sequence from file input.txt with Probcons. Record resulting alignment \r
42 into the output.txt \r
43 \r
44 Jws2Client -h=http://www.compbio.dundee.ac.uk/jabaws -s=ProbconsWS -i=input.txt -o=output.txt\r
45 \r
46 4) Calculate disorder with Disembl take input from input.txt, output results to \r
47 the console \r
48 \r
49 Jws2Client -h=http://www.compbio.dundee.ac.uk/jabaws -s=DisemblWS -i=input.txt \r
50 \r
51 5) List all parameters available for AAconWS service \r
52 \r
53 Jws2Client -h=http://www.compbio.dundee.ac.uk/jabaws -s=AAconWS -parameters\r
54 \r
55 6) Calculate conservation with AAConWS using LANDGRAF method, for Clustal alignment \r
56 from input.txt and report  the scores to the console \r
57 \r
58 Jws2Client -h=http://www.compbio.dundee.ac.uk/jabaws -s=AAconWS -i=input.txt -f=prm.txt \r
59 \r
60 Where the content of prm.txt file is -m=LANDGRAF\r
61 The list of the supported parameters can be obtained as shown in the example 5. \r
62 \r
63 Citation: Peter V. Troshin, James B. Procter and Geoffrey J. Barton - "Java \r
64 Bioinformatics Analysis Web Services for Multiple Sequence Alignment - \r
65 JABAWS:MSA" Bioinformatics 2011; doi: 10.1093/bioinformatics/btr304.\r