Data : Data related parameters

# appendNetworkData

Array containing additional data files to append to networks. Useful for loading KEGG and Wikipatways to decorate the nodes and the edges
Type: array
Default: []

# asSampleFactors

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
Type: array
Default: []

# asVariableFactors

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
Type: array
Default: []

# dataLabelAlign

Align for the data labels
Type: string
Default: center
Options: left, center, right

# dataLabelBaseline

Baseline for the data labels
Type: string
Default: middle
Options: top, middle, bottom

# dataLabelColor


# dataLabelFontSize

Font size for the text in data labels. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the dataLabelScaleFontFactor
Type: integer
Default: 12

# dataLabelFontStyle

Font style for the data labels
Type: string
Default:
Options: , bold, italic, bold italic

# dataLabelMargin


# dataLabelRotate


# dataLabelScaleFontFactor

Scaling factor used to increase or decrease the data labels font size in the canvas
Type: float
Default: 1

# groupingFactors

An array that holds the group names used for grouping the data. It must be a category in the data.x object
Type: array
Default: []

# histogramData

Flag or sample annotation to create histogram. If true is specified then the histogram will be done with all data
Type: string
Default: false

# isBoxplotCalc

Flag to indicate if the iqr has been calculated when the graph type is Boxplot
Type: boolean Private
Default: false

# isGroupedData

Flag to indicate if the data is grouped
Type: boolean Private
Default: false

# isTransformedData

Flag to indicate if the data is transformed
Type: boolean Private
Default: false

# ratioGroupReference

Name of the group used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: string
Default: false
Options: false

# ratioLevelReference

Name of the level used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: string
Default:
Options:

# ratioReference

Default index of sample used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: integer
Default:

# ratioSampleReference

Name of the sample used in ratio transformation. Almost private parameters used within the different CanvasXpress UIs
Type: string
Default: false
Options: false

# segregateSamplesBy

An array that holds the annotation(s) used to segregate the samples ala Facet way in R. It must be categories in the data.x object
Type: array
Default: []

# segregateVariablesBy

An array that holds the annotation(s) used to segregate the variables ala Facet way in R. It must be categories in the data.z object
Type: array
Default: []

# splitSamplesBy

Factor (in the x data object) used to split the samples ala split in complex heatmap
Type: string
Default: false

# splitSeparation

Length in pixels to separate the splits in samples and variables
Type: integer
Default: 10

# splitVariablesBy

Factor (in the z data object) used to separate the variables ala split in complex heatmap
Type: string
Default: false

# stringEdgeAttributes

Array containing edge attributes. The numeric edge attributes will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for edges at load time
Type: array
Default: []

# stringNodeAttributes

Array containing node attributes. The numeric node attributes will be treated as strings. This parameter accomplishes the same as the function switchNumericToString for nodes at load time
Type: array
Default: []

# stringSampleFactors

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
Type: array
Default: []

# stringVariableFactors

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
Type: array
Default: []

# summaryType

Summary type for the data when grouping
Type: string
Default: false
Options: false, iqr, median, mean, cor, min, max, count, sum

# transformAxis

Default axis to use to transform the data when either z-score or ratio transformation is used
Type: string
Default: samples
Options: samples, variables

# transformBase

Default log or exponential transformation for the data
Type: integer Private
Default: 10

# transformData

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
Type: string
Default: false
Options: false, log2, log10, exp2, exp10, percentile, zscore, ratio2, ratio10, save, reset, undo

# transposeData

Flag to transpose data as a parameter. This parameter accomplishes the same as the function transpose at load time
Type: boolean
Default: false