Ignore:
Timestamp:
Jan 13, 2014, 8:08:30 AM (8 years ago)
Author:
Peter
Message:

closes #775

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/omic/BamFile.h

    r3078 r3160  
    55
    66/*
    7   Copyright (C) 2012, 2013 Peter Johansson
     7  Copyright (C) 2012, 2013, 2014 Peter Johansson
    88
    99  This file is part of the yat library, http://dev.thep.lu.se/yat
     
    193193
    194194    /**
     195       \brief Create an output bam file.
     196
     197       Equivalent to default constructor followed by a call to open(3).
     198
     199       \see open(const std::string&, const BamHeader&, unsigned int)
     200
     201       \since yat 0.12
     202     */
     203    OutBamFile(const std::string&, const BamHeader& header,
     204               unsigned int compression);
     205
     206    /**
    195207       \brief Open an output bam file.
    196208
     
    202214     */
    203215    void open(const std::string& fn, const BamHeader& hdr);
     216
     217    /**
     218       \brief Open an output bam file.
     219
     220       Opens an output bam file and writes the header contained in \a
     221       hdr. If \a fn is "-", \c stdout is used.
     222
     223       \param fn string specifying the filename
     224       \param hdr header
     225       \param compression a number [0,9] indicating level of
     226       compression. 9 gives highest compression and 0 indicates no
     227       compression (suitable for piping between applications)
     228
     229       \since yat 0.12
     230     */
     231    void open(const std::string& fn, const BamHeader& hdr,
     232              unsigned int compression);
    204233
    205234    /**
Note: See TracChangeset for help on using the changeset viewer.