File: acdlog.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 (372 lines) | stat: -rw-r--r-- 9,548 bytes parent folder | download | duplicates (7)
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
<HTML>

<HEAD>
  <TITLE>
  EMBOSS: acdlog
  </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="emboss_icon.jpg" alt="" width=150 height=48></a>
</td>
<td align=left valign=middle>
<b><font size="+6">
acdlog
</font></b>
</td></tr>
</table>
<br>&nbsp;
<p>


<H2>
Wiki
</H2>

The master copies of EMBOSS documentation are available
at <a href="http://emboss.open-bio.org/wiki/Appdocs">
http://emboss.open-bio.org/wiki/Appdocs</a>
on the EMBOSS Wiki.

<p>
Please help by correcting and extending the Wiki pages.

<H2>
    Function
</H2>
Test application ACD file processing and trace data structures

<H2>
    Description
</H2>

<p><b>acdlog</b> processes an ACD file and user input, while logging the contents of internal data structures.  For the time being it's use is deprecated and the entrails application should be used instead.</p>
<p><b>acdlog</b> works the same as <b>acdc</b> but reports on the data structures used to process the ACD file.</p>

<H2>
    Usage
</H2>
<b>Here is a sample session with acdlog</b>
<p>

<p>
<table width="90%"><tr><td bgcolor="#CCFFFF"><pre>

% <b>acdlog antigenic </b>
Finds antigenic sites in proteins
Input protein sequence(s): <b>tsw:actb1_takru</b>
Minimum length of antigenic region [6]: <b></b>
Output report [actb1_takru.antigenic]: <b></b>

</pre></td></tr></table><p>
<p>
<a href="#input.1">Go to the input files for this example</a><br><a href="#output.1">Go to the output files for this example</a><p><p>


<H2>
    Command line arguments
</H2>


The first parameter is the name of the program to compile.

All other command line parameters and qualifiers are defined for that
program - see the documentation for the program of choice.

<P>



<H2>
    Output file format
</H2>

<p>

The output file of the program being logged is empty, but any format
available to the specified program can be used.

<p>
The processing output is written to a file with the extension ".acdlog"
<p>

<a name="output.1"></a>
<h3>Output files for usage example </h3>
<p><h3>File: actb1_takru.antigenic</h3>
<table width="90%"><tr><td bgcolor="#CCFFCC">
<pre>
</pre>
</td></tr></table><p>
<p><h3>File: antigenic.acdlog</h3>
<table width="90%"><tr><td bgcolor="#CCFFCC">
<pre>
testing acdpromptsacdArgsScan acdDebug No acdDoHelp No
Trying acdfile '/homes/pmr/local/share/EMBOSS/acd/antigenic.acd' (installed)
Code file installed: '/homes/pmr/local/share/EMBOSS/acd/codes.english'
Code file /homes/pmr/local/share/EMBOSS/acd/codes.english used
add to table defalign 'Write output alignment to'
add to table defreport 'Write output report to'
add to table definteger 'Enter a number'
add to table deffloat 'Enter a number'
add to table defbool 'Yes or No'
add to table defdirectory 'Which directory'
add to table defoutfile 'Write output to'
add to table deffeatout 'Write features  to'
add to table defseqout 'Write sequence to'
add to table defseqoutset 'Write sequence set to'
add to table defseqoutall 'Write sequences to'
add to table defsequence 'Read sequence from'
add to table defseqset 'Read sequence set from'
add to table defseqall 'Read sequences from'
add to table defstring 'Enter text'
add to table defgraph 'Graph type'
add to table defxygraph 'Graph type'
add to table defrange 'Range(s)'
add to table helpdirectory 'Directory name'
add to table helpoutfile 'Output file name'
add to table helpalign 'Output alignment file name'
add to table helpreport 'Output report file name'
add to table helpfeatout 'Output features UFO'
add to table helpseqout 'Output sequence USA'
add to table helpseqoutset 'Output sequence set USA'
add to table helpseqoutall 'Output sequence(s) USA'
add to table helpsequence 'Sequence USA'
add to table helpseqset 'Sequence set USA'
add to table helpseqall 'Sequence database USA'
add to table helpgraph 'Graph type'
add to table helpxygraph 'Graph type'
add to table helpcodon 'Codon usage table name'
add to table helpoutcodon 'Codon usage table name'
add to table helpobo 'Ontology term query'
add to table helpoutobo 'Output ontology term file name'
add to table helpresource 'Data resource catalogue query'
add to table helpoutresource 'Output data resource file name'
add to table gap 'What gap penalty'
add to table gapext 'What gap extension penalty'
add to table fred 'Sanger special'
add to table ciao 'Hello from Bari'
Knowntypes file installed: '/homes/pmr/local/share/EMBOSS/acd/knowntypes.standard'
Knowntypes file /homes/pmr/local/share/EMBOSS/acd/knowntypes.standard used
acdSetDefC auto 'N' 1202710
acdSetDefC stdout 'N' 11eb970
acdSetDefC filter 'N' 11ebba0


<font color=red>  [Part of this file has been deleted for brevity]</font>

      Assoc: No
 AssocQuals: rformat
    Defined: No
    Userdefined: No
Orig. Value: ''
      Value: 'actb1_takru.antigenic'

      Default Attributes:
         default: 'actb1_takru.antigenic'
     information: ''
          prompt: ''
            code: ''
            help: ''
       parameter: 'Y'
        standard: 'Y'
      additional: ''
         missing: ''
           valid: ''
        expected: ''
          needed: ''
       knowntype: ''
       relations: 'EDAM:0001534 data Peptide immunogenicity report'
  outputmodifier: ''
           style: ''
       qualifier: ''
        template: ''

      Attributes:
            type: ''
         taglist: 'int:pos=Max_score_pos'
        multiple: 'Y'
       precision: ''
     nulldefault: ''
          nullok: ''

ACD 48
       Name: 'output'
      Token: 'output'
      Param: 0
      Level: 6   (ENDSEC)
   Key Type: 5   (endsection)
      NAttr: 0
      Assoc: No
 AssocQuals: &lt;undefined&gt;
    Defined: No
    Userdefined: No
Orig. Value: '&lt;null&gt;'
      Value: &lt;undefined&gt;

      Attributes:

</pre>
</td></tr></table><p>


<H2>
    Data files
</H2>


Acdlog will use any data files specified in the ACD file of the
specified program, but will ignore any data files that are only used
directly by the program's code.

<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>

<H2>
    Notes
</H2>
<p><b>acdlog</b> does not have its own options, but takes a single parameter which is the name of the EMBOSS application that is being testsed.  It is invoked by specifying the name of the application to be tested along with any command-line options after the name of the utility application itself:</p>

<p><tt><b>acdlog</b> ApplicationName  Options</tt></p>

<p><b>acdlog</b> will run the command line interface of any EMBOSS program by reading its ACD file and processing the command line and user responses in exactly the same way as if the true program itself were running.  The application proper is not run; it is only the ACD file that is read.  Any command-line options for the application being called can be specified. The user is prompted for any required values for application parameters and any input files are read. Output files can be specified in any available format however they will be empty (the application code is not called so there will be no output).</p>


<H2>
    References
</H2>


<H2>
    Warnings
</H2>


None.

<H2>
    Diagnostic Error Messages
</H2>



<H2>
    Exit status
</H2>


It exits with status 0.

<H2>
    Known bugs
</H2>


None.


<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="acdc.html">acdc</a></td>
<td>Test an application ACD file</td>
</tr>

<tr>
<td><a href="acdpretty.html">acdpretty</a></td>
<td>Correctly reformat an application ACD file</td>
</tr>

<tr>
<td><a href="acdrelations.html">acdrelations</a></td>
<td>Add relations: attribute to ACD files</td>
</tr>

<tr>
<td><a href="acdtable.html">acdtable</a></td>
<td>Generate an HTML table of parameters from an application ACD file</td>
</tr>

<tr>
<td><a href="acdtrace.html">acdtrace</a></td>
<td>Trace processing of an application ACD file (for testing)</td>
</tr>

<tr>
<td><a href="acdvalid.html">acdvalid</a></td>
<td>Validate an application ACD file</td>
</tr>

</table>
<H2>
    Author(s)
</H2>

Peter Rice
<br>
European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK

<p>
Please report all bugs to the EMBOSS bug team (emboss-bug&nbsp;&copy;&nbsp;emboss.open-bio.org) not to the original author.

<H2>
    History
</H2>


<H2>
    Target users
</H2>
This program is intended to be used by developers of applications and
interfaces. 

<H2>
    Comments
</H2>
None



</BODY>
</HTML>