dot-write.gctx: Write a GCT object to disk in GCTX format

.write.gctxR Documentation

Write a GCT object to disk in GCTX format

Description

Write a GCT object to disk in GCTX format

Usage

.write.gctx(
  ds,
  ofile,
  appenddim = T,
  compression_level = 0,
  matrix_only = F,
  max_chunk_kb = 1024
)

Arguments

ds

a GCT object

ofile

the desired file path for writing

appenddim

boolean indicating whether the resulting filename will have dimensions appended (e.g. my_file_n384x978.gctx)

compression_level

integer between 1-9 indicating how much to compress data before writing. Higher values result in smaller files but slower read times.

matrix_only

boolean indicating whether to write only the matrix data (and skip row, column annotations)

max_chunk_kb

for chunking, the maximum number of KB a given chunk will occupy

See Also

Other GCTX parsing functions: .append.dim(), .fix.datatypes(), .parse.gctx(), .process_ids(), .read.gctx.ids(), .read.gctx.meta(), .write.gct(), .write.gctx.meta()


kalganem/creedenzymatic documentation built on March 31, 2024, 11:58 a.m.