toCX: Convert an RCX object to CX (JSON)

Description Usage Arguments Details Value See Also Examples

View source: R/Json-toJson.R

Description

This function converts an RCX object to JSON in a valid CX data structure (see NDEx documentation: https://home.ndexbio.org/data-model/).

Usage

1
toCX(rcx, verbose = F, pretty = F)

Arguments

rcx

RCX object

verbose

logical; whether to print what is happening

pretty

logical; adds indentation whitespace to JSON output. Can be TRUE/FALSE or a number specifying the number of spaces to indent. See jsonlite::prettify()

Details

The single aspects of the RCX object are processed by generic functions of rcxToJson for each aspect class. Therefore, not only the single aspects are converted to JSON, but also necessary additional aspects are added, so the resulting CX is accepted by the NDEx platform (https://ndexbio.org/):

If the RCX object contains additional aspects besides the officially defined ones, the corresponding rcxToJson functions for those aspect classes have to be implemented in order to include them in the resulting CX.

Value

CX (JSON) text

See Also

toCX, rcxToJson, readCX, writeCX

Examples

1

frankkramer-lab/RCX documentation built on July 14, 2021, 6:33 p.m.