-
public class BigWigFile.Companion
-
-
Field Summary
Fields Modifier and Type Field Description public final static BigWigFile.CompanionINSTANCE
-
Method Summary
Modifier and Type Method Description final BigWigFileread(Path path, Function0<Unit> cancelledChecker)final BigWigFileread(String src, Integer prefetch, Function0<Unit> cancelledChecker, Function2<String, ByteOrder, RomBufferFactory> factoryProvider)final Unitwrite(Iterable<WigSection> wigSections, Iterable<Pair<String, Integer>> chromSizes, Path outputPath, Integer zoomLevelCount, CompressionType compression, ByteOrder order, Function0<Unit> cancelledChecker)Creates a BigWIG file from given sections. -
-
Method Detail
-
read
final BigWigFile read(Path path, Function0<Unit> cancelledChecker)
-
read
final BigWigFile read(String src, Integer prefetch, Function0<Unit> cancelledChecker, Function2<String, ByteOrder, RomBufferFactory> factoryProvider)
-
write
@JvmOverloads() final Unit write(Iterable<WigSection> wigSections, Iterable<Pair<String, Integer>> chromSizes, Path outputPath, Integer zoomLevelCount, CompressionType compression, ByteOrder order, Function0<Unit> cancelledChecker)
Creates a BigWIG file from given sections.
- Parameters:
wigSections- sections sorted by chromosome and start offset.chromSizes- chromosome names and sizes, e.g.outputPath- BigWIG file path.zoomLevelCount- number of zoom levels to pre-compute.compression- method for data sections, see CompressionType.order- byte order used, see java.nio.ByteOrder.cancelledChecker- Throw cancelled exception to abort operation
-
-
-
-