Next: , Previous: , Up: Exporting   [Contents]

2.4.2 Write alignment blocks to an external alignment file.

The OutputAlignments filter writes all blocks to an external alignment file, potentially losing some information such as coordinates and scores. Sequence names will be formated following the Ensembl convention when coordinates are available.

Synopsis:

maf.filter=                                 \
    [...],
    OutputAlignments(                       \
        file=data.filtered.aln,             \
        compression=none,                   \
        format=Clustal,                     \
        mask=no,                            \
        coordinates=yes),                   \
    [...]

Arguments:

file={none|{path}}

A file path where to write alignment blocks. If the file name contains the %i code, one alignment file per block will be generated, where %i will be replaced by the block index. In addition to the %i special code, additional variables can be used (in combination with %i, in order to avoid putative identical file names): chromosome number (%c), begin (%b) and end (%e) of reference sequence.

format={string}

One of the alignment format supported by Bio++ (this includes Fasta, Mase and Clustal, see the Bio++ Program suite reference manual for a complete list of formats and options).

compression={none|gzip|zip|bzip2}

Compression format for output file.

mask={yes|no}

Tell if sequences should be masked (if a mask annotation is available), or if masking information should be ignored.

coordinates={yes|no}

Tell if coordinates of sequences should be written in the header of each sequence (followinf Ensembl syntax). If set to no, or if sequences have no coordinates, only the species name will be used as a sequence name.

ldhat_header={yes|no}

Tell if a header line should be added for each file, in order to be used with the LDhat convert program. This line contains the nimber of sequences, the sequence lengths, and the number 1 (for haploid).

reference={string}

The name of reference sequence, which will only be used when %c, %b or %e codes are used in file names. In case a block does not contain a sequence for the reference species, "ChrNA", "StartNA" and "StopNA" tags will be used.