write_gct: Write a GCT object to disk in GCT format

Description Usage Arguments Details Value See Also Examples

View source: R/io.R

Description

Write a GCT object to disk in GCT format

Usage

1
2
3
write.gct(...)

write_gct(ds, ofile, precision = 4, appenddim = TRUE, ver = 3)

Arguments

...

arguments passed on to write_gct

ds

the GCT object

ofile

the desired output filename

precision

the numeric precision at which to save the matrix. See details.

appenddim

boolean indicating whether to append matrix dimensions to filename

ver

the GCT version to write. See details.

Details

Since GCT is text format, the higher precision you choose, the larger the file size. ver is assumed to be 3, aka GCT version 1.3, which supports embedded row and column metadata in the GCT file. Any other value passed to ver will result in a GCT version 1.2 file which contains only the matrix data and no annotations.

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.gctx()

Examples

1
2
# note this will create a GCT file in your current directory
write_gct(ds, "dataset", precision=2)

cmapR documentation built on Dec. 12, 2020, 2 a.m.