Data

Data related parameters


appendNetworkData array
Array containing additional data files to append to networks. Useful for loading KEGG and Wikipatways to decorate the nodes and the edges.
Default: []
asHistogram string
Flag or sample annotation to create histogram. If 'true' is specified then the histogram will be done with all data
Default: false
Array containing variable names. Numeric variable data (in rows) to be treated as a sample factor (move from 'y' to 'x' object). This parameter accomplishes the same as the function switchVarToAnnotation at load time. It can be used in conjunction with the parameter stringSampleFactors to be treated as a string. TO DO: write example.
Default: []
Array containing sample names. Numeric sample data (in columns) to be treated as a variable factor (move from 'y' to 'z' object). This parameter accomplishes the same as the function switchSmpToAnnotation at load time. It can be used in conjunction with the parameter stringVariableFactors to be treated as a string. TO DO: write example.
Default: []
An array that holds the group names used for grouping the data. It must be a category in the 'data.x' object
Default: []
isBoxPlotCalc boolean Private
Flag to indicate if the iqr has been calculated when the graph type is Boxplot.
Default: false
isGroupedData boolean Private
Flag to indicate if the data is grouped.
Default: false
isMarketDataFormated boolean Private
Flag to indicate if the data has been formated to display Candlestick.
Default: false
isMarketSwitched boolean Private
Flag to indicate if the data is a Candlestick.
Default: false
isTransformedData boolean Private
Flag to indicate if the data is transformed.
Default: false
ratioGroupReference option
Name of the group used in ratio transformation. Almost 'private' parameters used within the different CanvasXpress UIs.
Default: false
Options: false
ratioLevelReference option
Name of the level used in ratio transformation. Almost 'private' parameters used within the different CanvasXpress UIs.
Default:
ratioReference integer
Default index of sample used in ratio transformation. Almost 'private' parameters used within the different CanvasXpress UIs.
Default: 0
ratioSampleReference option
Name of the sample used in ratio transformation. Almost 'private' parameters used within the different CanvasXpress UIs.
Default: false
Options: false
An array that holds the annotation(s) used to segregate the samples. It must be categories in the 'data.x' object
Default: []
An array that holds the annotation(s) used to segregate the variables. It must be categories in the 'data.z' object
Default: []
Array containing sample factors. The numeric sample factors will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for samples at load time. It can be used in conjunction with the parameter asSampleFactors. TO DO: write example.
Default: []
Array containing variable factors. The numeric variable factors will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for variables at load time. It can be used in conjunction with the parameter asVariableFactors. TO DO: write example.
Default: []
summaryType option
Summary type for the data when grouping
Default: false
Options: false, iqr, median, mean, cor, min, max, sum
transformAxis option
Default axis to use to transform the data when either z-score or ratio transformation is used.
Default: samples
Options: samples, variables
transformBase integer Private
Default log or exponential transformation for the data.
Default: 10
Options: 2, 10
transformType option
Default transformation type for ALL the data. Data can also be transformed by axis (x,y,z) to give more flexibility. false, save, reset and undo are NOT real transformations. They are only used in the canvasXpress UIs to save the transformed data.
Default: false
Options: false, log2, log10, exp2, exp10, percentile, zscore, ratio2, ratio10, save, reset, undo
transformedData boolean
Flag to transform data as a parameter. Works with transformType and transformAxis
Default: false
transposeData boolean
Flag to transpose data as a parameter. This parameter accomplishes the same as the function transpose at load time.
Default: false