Mercurial > repos > dawe > srf2fastq
comparison srf2fastq/io_lib-1.12.2/man/man3/write_reading.3 @ 0:d901c9f41a6a default tip
Migrated tool version 1.0.1 from old tool shed archive to new tool shed repository
| author | dawe |
|---|---|
| date | Tue, 07 Jun 2011 17:48:05 -0400 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:d901c9f41a6a |
|---|---|
| 1 .TH write_reading 3 "" "" "Staden Package" | |
| 2 | |
| 3 .SH NAME | |
| 4 | |
| 5 .LP | |
| 6 .BR write_reading , | |
| 7 .BR fwrite_reading | |
| 8 \- Write a \fBRead\fR structure into a trace file. | |
| 9 | |
| 10 .SH SYNOPSIS | |
| 11 .LP | |
| 12 .nf | |
| 13 .ft B | |
| 14 #include <Read.h> | |
| 15 | |
| 16 .nf | |
| 17 .ft B | |
| 18 int write_reading( | |
| 19 char *filename, | |
| 20 Read *read, | |
| 21 int format); | |
| 22 .ft | |
| 23 .fi | |
| 24 .LP | |
| 25 .nf | |
| 26 .ft B | |
| 27 int fwrite_reading( | |
| 28 FILE *fp, | |
| 29 Read *read, | |
| 30 int format); | |
| 31 .ft | |
| 32 .fi | |
| 33 .IX "write_reading()" "" "write_reading()" | |
| 34 .IX "fwrite_reading()" "" "fwrite_reading()" | |
| 35 | |
| 36 .SH DESCRIPTION | |
| 37 .LP | |
| 38 These functions write a \fBRead\fR structure into a trace file. The principle | |
| 39 format support is the SCF format. Although reading is supported for ABI and | |
| 40 ALF, writing is not. Additionally, it is possible to write using the plain | |
| 41 (old) staden format files or as Experiment files. In both these cases only the | |
| 42 sequence component of the trace file will be written. | |
| 43 .LP | |
| 44 When writing as an experiment file the QL, QR and SQ fields are generated from | |
| 45 the \fBRead\fR structure. If we previously created the \fBRead\fR structure | |
| 46 from reading an experiment file then the original experiment file data is also | |
| 47 written. Otherwise EN, ID, LN and LT lines are also generated. | |
| 48 .LP | |
| 49 .B write_reading() | |
| 50 writes a \fBRead\fR structure to the specified filename in the specified | |
| 51 format. Formats available are | |
| 52 .BR TT_SCF , | |
| 53 .BR TT_PLN and | |
| 54 .BR TT_EXP. | |
| 55 Specifying format \fBTT_ANY\fR will be treated as \fBTT_SCF\fR. | |
| 56 .LP | |
| 57 .B fwrite_reading() | |
| 58 writes a \fBRead\fR structure to the specified FILE pointer in the specified | |
| 59 format. Apart from writing to FILE pointer instead of a filename, the function | |
| 60 is identical to \fBwrite_reading()\fR. | |
| 61 | |
| 62 .SH RETURN VALUES | |
| 63 .LP | |
| 64 On successful completion, the \fBwrite_reading()\fR and \fBfwrite_reading()\fR | |
| 65 functions return 0. Otherwise these functions return -1. | |
| 66 | |
| 67 .SH SEE ALSO | |
| 68 .LP | |
| 69 .BR read_reading (3), | |
| 70 .BR fread_reading (3), | |
| 71 .BR deallocate_reading (3), | |
| 72 .BR scf (4), | |
| 73 .br | |
| 74 .BR ExperimentFile (4) |