object SamWriter extends LazyLogging
- Alphabetic
- By Inheritance
- SamWriter
- LazyLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- var DefaultCompressionLevel: Int
- var DefaultCreateIndex: Boolean
- var DefaultMaxRecordsInRam: Int
- var DefaultUseAsyncIo: Boolean
-
def
apply(path: FgBioDef.PathToBam, header: SAMFileHeader, sort: Option[SamOrder] = None, ref: Option[FgBioDef.PathToFasta] = None, async: Boolean = DefaultUseAsyncIo, buffer: Int = Defaults.NON_ZERO_BUFFER_SIZE, compression: Int = DefaultCompressionLevel, tmp: Option[FgBioDef.DirPath] = None, maxRecordsInRam: Int = 1e6.toInt, index: Boolean = true, md5: Boolean = false, sortProgress: Option[ProgressLogger] = ..., writeProgress: Option[ProgressLogger] = ...): SamWriter
Constructs a SamWriter for writing out SamRecords.
Constructs a SamWriter for writing out SamRecords.
- path
the path at which the data should be written
- header
the header for the SAM/BAM
- sort
an optional SamOrder into which to sort the reads. If no order is provided the reads are assumed to be in the order described in the header. If an order is provided the reads are _always_ sorted using that SamOrder before being emitted.
- ref
an optional reference sequence for use in writing CRAM
- async
if true use multiple threads to increase writing throughput
- buffer
the buffer size, in bytes, to use for the writer
- compression
the GZIP compression level to use when compressing data
- tmp
an optional tmp directory to use when sorting
- maxRecordsInRam
the maximum number of records to keep in RAM while sorting
- index
if true, index the SAM/BAM file on the fly while writing
- md5
if true, create an MD5 file for the output file while writing
- sortProgress
an optional ProgressLogger to use if/when putting records into a Sorter
- writeProgress
an optional ProgressLogger to use when writing records out
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
lazy val
logger: Logger
- Attributes
- protected
- Definition Classes
- LazyLogging
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )