Safe Haskell	None
Language	Haskell2010

Bio.Bam.Writer

Description

Printers for BAM and SAM. BAM is properly supported, SAM can be piped to standard output.

Synopsis

class IsBamRec a where
encodeBamWith :: (MonadIO m, IsBamRec r) => Int -> BamMeta -> Enumeratee [r] ByteString m ()
packBam :: BamRec -> IO BamRaw
writeBamFile :: IsBamRec r => FilePath -> BamMeta -> Iteratee [r] IO ()
writeBamHandle :: (MonadIO m, IsBamRec r) => Handle -> BamMeta -> Iteratee [r] m ()
pipeBamOutput :: IsBamRec r => BamMeta -> Iteratee [r] IO ()
pipeSamOutput :: MonadIO m => BamMeta -> Iteratee [BamRec] m ()

Documentation

class IsBamRec a where Source #

Minimal complete definition

pushBam

Methods

pushBam :: a -> BgzfTokens -> BgzfTokens Source #

Instances

IsBamRec BamRaw Source #
Instance details Defined in Bio.Bam.Writer Methods pushBam :: BamRaw -> BgzfTokens -> BgzfTokens Source #
IsBamRec BamRec Source #
Instance details Defined in Bio.Bam.Writer Methods pushBam :: BamRec -> BgzfTokens -> BgzfTokens Source #
(IsBamRec a, IsBamRec b) => IsBamRec (Either a b) Source #
Instance details Defined in Bio.Bam.Writer Methods pushBam :: Either a b -> BgzfTokens -> BgzfTokens Source #

encodeBamWith :: (MonadIO m, IsBamRec r) => Int -> BamMeta -> Enumeratee [r] ByteString m () Source #

Encodes BAM records straight into a dynamic buffer, the BGZF's it. Should be fairly direct and perform well.

packBam :: BamRec -> IO BamRaw Source #

writeBamFile :: IsBamRec r => FilePath -> BamMeta -> Iteratee [r] IO () Source #

Writes BAM encoded stuff to a file.

writeBamHandle :: (MonadIO m, IsBamRec r) => Handle -> BamMeta -> Iteratee [r] m () Source #

Writes BAM encoded stuff to a Handle.

pipeBamOutput :: IsBamRec r => BamMeta -> Iteratee [r] IO () Source #

write BAM encoded stuff to stdout This send uncompressed BAM to stdout. Useful for piping to other tools.

pipeSamOutput :: MonadIO m => BamMeta -> Iteratee [BamRec] m () Source #

write in SAM format to stdout This is useful for piping to other tools (say, AWK scripts) or for debugging. No convenience function to send SAM to a file exists, because that's a stupid idea.