Mercurial > repos > dawe > srf2fastq
comparison srf2fastq/io_lib-1.12.2/man/man3/scf2read.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 scf2read 3 "" "" "Staden Package" | |
| 2 | |
| 3 .SH NAME | |
| 4 | |
| 5 .LP | |
| 6 .BR scf2read , | |
| 7 .BR read2scf , | |
| 8 .BR exp2read , | |
| 9 .BR read2exp | |
| 10 \- Translate to and from the \fBRead\fR structure. | |
| 11 | |
| 12 .SH SYNOPSIS | |
| 13 .LP | |
| 14 .nf | |
| 15 .ft | |
| 16 #include <Read.h> | |
| 17 | |
| 18 .nf | |
| 19 .ft B | |
| 20 Read *scf2read( | |
| 21 Scf *scf); | |
| 22 .ft | |
| 23 .fi | |
| 24 .LP | |
| 25 .nf | |
| 26 .ft B | |
| 27 Scf *read2scf( | |
| 28 Read *read); | |
| 29 .ft | |
| 30 .fi | |
| 31 .LP | |
| 32 .nf | |
| 33 .ft B | |
| 34 Exp_info *read2exp( | |
| 35 Read *read, | |
| 36 char *EN); | |
| 37 .ft | |
| 38 .fi | |
| 39 .LP | |
| 40 .nf | |
| 41 .ft B | |
| 42 Read *exp2read( | |
| 43 Exp_info *e); | |
| 44 .ft | |
| 45 .fi | |
| 46 .IX "scf2read()" "" "scf2read()" | |
| 47 .IX "read2scf()" "" "read2scf()" | |
| 48 .IX "read2exp()" "" "read2exp()" | |
| 49 .IX "exp2read()" "" "exp2reead()" | |
| 50 | |
| 51 .SH DESCRIPTION | |
| 52 .LP | |
| 53 These functions are used internally by the io library for converting between | |
| 54 the in memory representations of the supported file formats. The \fBRead\fR | |
| 55 structure is the central format so only conversion to and from this structure | |
| 56 is available. Conversions consist of to and from the SCF format and to and | |
| 57 from the Experiment File format. | |
| 58 .LP | |
| 59 .B scf2read() | |
| 60 converts an \fBScf\fR structure into a \fBRead\fR structure. The \fBRead\fR | |
| 61 structure is allocated by the function. The \fBScf\fR structure is left | |
| 62 unchanged. | |
| 63 .LP | |
| 64 .B read2scf() | |
| 65 converts a \fBRead\fR structure into an \fBScf\fR structure. The \fBScf\fR | |
| 66 structure is allocated by the function. The \fBRead\fR structure is left | |
| 67 unchanged. | |
| 68 .LP | |
| 69 .B exp2read() | |
| 70 converts an \fBExp_info\fR structure into a \fBRead\fR structure. The | |
| 71 entryname to use in the EN line type of the Experiment File must be specified. | |
| 72 The \fBRead\fR structure is allocated by the function. The \fBExp_info\fR | |
| 73 structure is left unchanged. | |
| 74 .LP | |
| 75 .B read2exp() | |
| 76 converts a \fBRead\fR structure into an \fBExp_info\fR structure. The | |
| 77 \fBExp_info\fR structure is allocated by the function. The \fBRead\fR | |
| 78 structure is left unchanged. | |
| 79 | |
| 80 .SH RETURN VALUES | |
| 81 .LP | |
| 82 On successful completion, the \fBscf2read()\fR and \fBexp2read\fR functions | |
| 83 return a pointer to an allocated \fBRead\fR structure. Otherwise these | |
| 84 functions return NULLRead. | |
| 85 .LP | |
| 86 On successful completion, the \fBread2scf\fR function returns a pointer to an | |
| 87 allocated \fBScf\fR structure. Otherwise this function returns a null pointer. | |
| 88 .LP | |
| 89 On successful completion, the \fBread2exp\fR function returns a pointer to an | |
| 90 allocated \fBExp_info\fR structure. Otherwise this function returns a null | |
| 91 pointer. | |
| 92 | |
| 93 .SH SEE ALSO | |
| 94 .LP | |
| 95 .BR read_reading (3), | |
| 96 .BR fread_reading (3), | |
| 97 .BR write_reading (3), | |
| 98 .BR fwrite_reading (3), | |
| 99 .BR scf (4), | |
| 100 .BR ExperimentFile (4) |