write.gctx {cmapR} | R Documentation

## Write a GCT object to disk in GCTX format

### Description

Write a GCT object to disk in GCTX format

### Usage

    write.gctx(...)

    write_gctx(
      ds,
      ofile,
      appenddim = TRUE,
      compression_level = 0,
      matrix_only = FALSE,
      max_chunk_kb = 1024
    )

### Arguments

`...` | arguments passed on to `write_gctx`
`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

### Value

silently returns NULL

### See Also

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

### Examples

    # note this will create a GCT file in your current directory
    write_gctx(ds, "dataset")

[Package cmapR version 1.0.0 Index]