CombinedScatter: CombinedScatter

View source: R/combinedscatterplot.R

CombinedScatterR Documentation

CombinedScatter

Description

Scatter plot (uses rhtmlCombinedScatter)

Usage

CombinedScatter(
  x = NULL,
  y = NULL,
  scatter.x.column = 1,
  scatter.y.column = 2,
  scatter.labels = NULL,
  scatter.labels.name = "",
  scatter.sizes = NULL,
  scatter.sizes.name = "",
  scatter.sizes.column = 3,
  scatter.sizes.as.diameter = FALSE,
  scatter.colors = NULL,
  scatter.colors.name = "",
  scatter.colors.column = 4,
  scatter.colors.as.categorical = TRUE,
  scatter.groups = NULL,
  scatter.groups.column = NULL,
  scatter.labels.as.hovertext = TRUE,
  scatter.max.labels = 50,
  scatter.max.groups = 50,
  annotation.list = NULL,
  colors = ChartColors(12),
  trend.lines = FALSE,
  logos = NULL,
  logo.size = 0.5,
  fit.type = "None",
  fit.window.size = 3,
  fit.ignore.last = FALSE,
  fit.line.type = "dot",
  fit.line.width = 1,
  fit.line.colors = colors,
  fit.line.opacity = 1,
  fit.CI.show = FALSE,
  fit.CI.colors = fit.line.colors,
  fit.CI.opacity = 0.4,
  legend.show = TRUE,
  legend.orientation = "Vertical",
  legend.wrap = TRUE,
  legend.wrap.nchar = 30,
  global.font.family = "Arial",
  global.font.color = rgb(44, 44, 44, maxColorValue = 255),
  title = "",
  title.font.family = global.font.family,
  title.font.color = global.font.color,
  title.font.size = 16,
  subtitle = "",
  subtitle.font.family = global.font.family,
  subtitle.font.color = global.font.color,
  subtitle.font.size = 12,
  panel.title.font.family = global.font.family,
  panel.title.font.color = global.font.color,
  panel.title.font.size = 14,
  nrows = 2,
  share.axes = TRUE,
  x.order = NULL,
  panel.x.gap = 0.2,
  panel.y.gap = 0.3,
  footer = "",
  footer.font.family = global.font.family,
  footer.font.color = global.font.color,
  footer.font.size = 8,
  footer.wrap = TRUE,
  footer.wrap.nchar = 100,
  data.label.font.family = global.font.family,
  data.label.font.color = global.font.color,
  data.label.font.autocolor = FALSE,
  data.label.font.size = 10,
  data.label.format = "",
  data.label.prefix = "",
  data.label.suffix = "",
  opacity = NULL,
  background.fill.color = "transparent",
  charting.area.fill.color = background.fill.color,
  legend.font.color = global.font.color,
  legend.font.family = global.font.family,
  legend.font.size = 10,
  legend.position.y = 1,
  legend.position.x = 1.02,
  legend.title = "",
  legend.title.font.color = global.font.color,
  legend.title.font.family = global.font.family,
  legend.title.font.size = 12,
  legend.title.wrap = TRUE,
  legend.title.wrap.nchar = 30,
  legend.bubble.title = "",
  legend.bubble.font.color = global.font.color,
  legend.bubble.font.family = global.font.family,
  legend.bubble.font.size = 10,
  legend.bubble.title.font.color = global.font.color,
  legend.bubble.title.font.family = global.font.family,
  legend.bubble.title.font.size = 12,
  legend.bubble.title.wrap = TRUE,
  legend.bubble.title.wrap.nchar = 30,
  margin.autoexpand = TRUE,
  margin.top = NULL,
  margin.bottom = NULL,
  margin.left = NULL,
  margin.right = NULL,
  grid.show = TRUE,
  y.title = "",
  y.title.font.color = global.font.color,
  y.title.font.family = global.font.family,
  y.title.font.size = 12,
  y.line.width = 0,
  y.line.color = rgb(0, 0, 0, maxColorValue = 255),
  y.tick.mark.length = 0,
  y.tick.mark.color = "transparent",
  y.bounds.minimum = NULL,
  y.bounds.maximum = NULL,
  y.tick.distance = NULL,
  y.tick.maxnum = NULL,
  y.zero.line.width = 0,
  y.zero.line.color = rgb(225, 225, 225, maxColorValue = 255),
  y.zero.line.dash = "Dash",
  y.grid.width = 1 * grid.show,
  y.grid.color = rgb(225, 225, 225, maxColorValue = 255),
  y.grid.dash = "Solid",
  y.tick.show = TRUE,
  y.tick.suffix = "",
  y.tick.prefix = "",
  y.tick.format = "",
  y.hovertext.format = "",
  y.tick.font.color = global.font.color,
  y.tick.font.family = global.font.family,
  y.tick.font.size = 10,
  x.title = "",
  x.title.font.color = global.font.color,
  x.title.font.family = global.font.family,
  x.title.font.size = 12,
  x.line.width = 0,
  x.line.color = rgb(0, 0, 0, maxColorValue = 255),
  x.tick.mark.length = 3,
  x.tick.mark.color = "transparent",
  x.bounds.minimum = NULL,
  x.bounds.maximum = NULL,
  x.tick.distance = NULL,
  x.tick.maxnum = NULL,
  x.zero.line.width = 0,
  x.zero.line.color = rgb(225, 225, 225, maxColorValue = 255),
  x.zero.line.dash = "Dash",
  x.grid.width = 1 * grid.show,
  x.grid.color = rgb(225, 225, 225, maxColorValue = 255),
  x.grid.dash = "Solid",
  x.tick.show = TRUE,
  x.tick.suffix = "",
  x.tick.prefix = "",
  x.tick.format = "",
  x.hovertext.format = "",
  x.tick.angle = NULL,
  x.tick.font.color = global.font.color,
  x.tick.font.family = global.font.family,
  x.tick.font.size = 10,
  x.tick.label.wrap = TRUE,
  x.tick.label.wrap.nchar = 21,
  hovertext.font.family = global.font.family,
  hovertext.font.size = 11,
  marker.size = 6,
  swap.x.and.y = FALSE,
  legend.bubbles.show = NULL,
  color.scale.show = NULL,
  label.auto.placement = TRUE,
  quadrants.show = FALSE,
  x.midpoint.type = "Average",
  x.midpoint.input = NULL,
  x.midpoint.value = NULL,
  y.midpoint.type = "Average",
  y.midpoint.input = NULL,
  y.midpoint.value = NULL,
  x.midpoint.line.color = rgb(0, 0, 0, maxColorValue = 255),
  x.midpoint.line.dash = "Solid",
  x.midpoint.line.width = 1,
  y.midpoint.line.color = rgb(0, 0, 0, maxColorValue = 255),
  y.midpoint.line.dash = "Solid",
  y.midpoint.line.width = 1,
  quadrant.top.left.color = "transparent",
  quadrant.top.right.color = "transparent",
  quadrant.bottom.left.color = "transparent",
  quadrant.bottom.right.color = "transparent",
  quadrant.top.left.title = "",
  quadrant.top.left.title.font.family = global.font.family,
  quadrant.top.left.title.font.color = global.font.color,
  quadrant.top.left.title.font.size = 12,
  quadrant.top.right.title = "",
  quadrant.top.right.title.font.family = global.font.family,
  quadrant.top.right.title.font.color = global.font.color,
  quadrant.top.right.title.font.size = 12,
  quadrant.bottom.left.title = "",
  quadrant.bottom.left.title.font.family = global.font.family,
  quadrant.bottom.left.title.font.color = global.font.color,
  quadrant.bottom.left.title.font.size = 12,
  quadrant.bottom.right.title = "",
  quadrant.bottom.right.title.font.family = global.font.family,
  quadrant.bottom.right.title.font.color = global.font.color,
  quadrant.bottom.right.title.font.size = 12,
  plot.border.show = FALSE,
  plot.border.color = rgb(0, 0, 0, maxColorValue = 255),
  plot.border.width = 1,
  fixed.aspect = FALSE
)

Arguments

x

A numeric vector for the x-axis coordinates (which may be named); or a matrix or datarame; or a list of matrices where each matrix share the same row and column names.

y

Optional numeric vector for the y-axis coordinates. Should contain the same number of observations as x. If not provided, will use x instead.

scatter.x.column

When x is a dataframe or matrix, the index of the column (1-based) which contains the x-coordinate data.

scatter.y.column

When x is a dataframe or matrix, the index of the column (1-based) which contains the y-coordinate data.

scatter.labels

Optional vector for labelling scatter points. This should be the same length as the number of observations in x and y.

scatter.labels.name

Character; Used for labelling subtitles and footers.

scatter.sizes

Numeric vector determining of the size of each observation. These can alternatively be provided as a column in x.

scatter.sizes.name

Character; Used for labelling footers and legends.

scatter.sizes.column

When x is a dataframe or matrix, the index of the column (1-based) which contains scatter.sizes data.

scatter.sizes.as.diameter

Whether to show the points with diameter (instead of area, which is the default) proportional to the sizes variable.

scatter.colors

Numeric, character, or categorical vector determining the color of each observation. These can alternatively be provided as a column in x.

scatter.colors.name

Character; Used for labelling footers.

scatter.colors.column

When x is a dataframe or matrix, the index of the column (1-based) which contains scatter.colors data.

scatter.colors.as.categorical

Boolean; Whether to treat colors as a categorical groups, or a numeric scale.

scatter.groups

A factor of the same length as x which is used to aggregate the data for small multiples.

scatter.groups.column

The column of x which is used to aggregate the data for small multiples (ignored when scatter.groups is provided)

scatter.labels.as.hovertext

Logical; if TRUE, labels are shown has hovers; otherwise, as a labeled scatterplot.

scatter.max.labels

Integer; the maximum number of labels to show on a Labeled Scatterplot. If the number of labels is greater than this parameter, extra labels will be hidden by default but can be toggled on by clicking on the marker.

scatter.max.groups

Maximum number of different color categories in data. The is equivalent to the number of enteries in the legend. Increasing this too high may cause performance issues.

annotation.list

Optional list of annotations to modify the data labels.

colors

A vector of colors to use in the chart. When scatter.colors.as.categorical, the vector of colors should have the length as the number of categories in scatter.colors. If scatter.colors is used as numeric vector, then a color ramp is constructed from the colors listed.

trend.lines

Boolean indicating whether to plot trend lines for multiple tables.

logos

Optional list of images to be used to label scatterplot instead of the row names. This should be input as a comma-seperated list of URLs.

logo.size

Numeric controlling the size of the logos.

fit.type

Character; type of line of best fit. Can be one of "None", "Linear", "LOESS", "Friedman's super smoother", "Cubic spline", "Moving average", "Centered moving average".

fit.window.size

Integer; Use to determine how the average is computed when fit.type "Moving average" or "Centered moving average".

fit.ignore.last

Logical; whether to ignore the last data point in the fit.

fit.line.type

Character; One of "solid", "dot", "dash, "dotdash", or length of dash "2px", "5px".

fit.line.width

Numeric; Line width of line of best fit.

fit.line.colors

Character; a vector containing one or more colors specified as hex codes.

fit.line.opacity

Opacity of trend line as an alpha value (0 to 1).

fit.CI.show

Show 95% confidence interval.

fit.CI.colors

Character; a vector containing one or more colors specified as hex codes.

fit.CI.opacity

Opacity of confidence interval ribbon as an alpha value (0 to 1).

legend.show

is the toggle to show the legend. Can be logical or "Automatic", "Show" or "Hide". When automatic, the legend is only shown when there is more than one group. Defaults to TRUE. When FALSE or "Hide", the colorscale and bubble legends are also hidden (if not overridden by their own "show" parameters).

legend.orientation

Character; One of 'Vertical' or 'Horizontal'

legend.wrap

Logical; whether the legend text should be wrapped.

legend.wrap.nchar

Number of characters (approximately) in each line of the legend when legend.wrap TRUE.

global.font.family

Character; font family for all occurrences of any font attribute for the chart unless specified individually.

global.font.color

Global font color as a named color in character format (e.g. "black") or an a hex code.

title

Character; chart title.

title.font.family

Character; title font family. Can be "Arial Black", "Arial", "Comic Sans MS", "Courier New", "Georgia", "Impact", "Lucida Console", "Lucida Sans Unicode", "Marlett", "Symbol", "Tahoma", "Times New Roman", "Trebuchet MS", "Verdana", "Webdings"

title.font.color

Title font color as a named color in character format (e.g. "black") or a hex code.

title.font.size

Integer; Title font size; default = 10.

subtitle

Character

subtitle.font.family

Character; subtitle font family

subtitle.font.color

subtitle font color as a named color in character format (e.g. "black") or an a hex code.

subtitle.font.size

Integer; subtitle font size

panel.title.font.family

Font family of panel titles.

panel.title.font.color

Font color of panel titles.

panel.title.font.size

Font size of panel titles.

nrows

Integer; Number of rows to arrange the small multiple panels.

share.axes

Force range of the plot to be the same across all panels.

x.order

A vector containing the list index of the columns in the order which they are to be shown, or a string with comma separated indices.

panel.x.gap

A number between 0 and 1. Controls the horizontal space between panels.

panel.y.gap

A number between 0 and 1. Controls the vertical space between panels.

footer

Character

footer.font.family

Character; footer font family

footer.font.color

footer font color as a named color in character format (e.g. "black") or an a hex code.

footer.font.size

Integer; footer font size

footer.wrap

Logical; whether the footer text should be wrapped.

footer.wrap.nchar

Number of characters (approximately) in each line of the footer when footer.wrap TRUE.

data.label.font.family

Character; font family for data label.

data.label.font.color

Font color as a named color in character format (e.g. "black") or an a hex code. This can be a single color, a vector of colors (1 for each series/column), or a comma separated list of colors

data.label.font.autocolor

Boolean; If true, data.label.font.color is ignored and labels are colored according to the series color.

data.label.font.size

Integer; Font size for data label.px.

data.label.format

A string representing a d3 formatting code. See https://github.com/mbostock/d3/wiki/Formatting#numbers

data.label.prefix

Character; prefix for data values.

data.label.suffix

Character; suffix for data values.

opacity

of scatter point colors as an alpha value (0 to 1).

background.fill.color

Background color in character format (e.g. "black") or a hex code.

charting.area.fill.color

Charting area background color as a named color in character format (e.g. "black") or a hex code.

legend.font.color

Legend font color as a named color in character format (e.g. "black") or a hex code.

legend.font.family

Character; legend font family.

legend.font.size

Integer; Legend font size.

legend.position.y

A numeric controlling the position of the legend. Values range from 0 (bottom) to 1 (top).

legend.position.x

A numeric controlling the position of the legend. Values range from -0.5 (left) to 1.5 (right).

legend.title

Title to show above the legend (and color scale bar)

legend.title.font.color

Font color of the legend (and color scale bar) title

legend.title.font.family

Font family of the legend (and color scale bar) title

legend.title.font.size

Font size of the legend (and color scale bar) title

legend.title.wrap

Whether to wrap the legend (and color scale bar) title

legend.title.wrap.nchar

The number of characters before wrapping the legend (and color scale bar) title

legend.bubble.title

Title to show above the bubble legend

legend.bubble.font.color

Font color of the bubble legend

legend.bubble.font.family

Font family of the bubble legend

legend.bubble.font.size

Font size of the bubble legend

legend.bubble.title.font.color

Font color of the bubble legend title

legend.bubble.title.font.family

Font family of the bubble legend title

legend.bubble.title.font.size

Font size of the bubble legend title

legend.bubble.title.wrap

Whether to wrap the bubble legend title

legend.bubble.title.wrap.nchar

The number of characters before wrapping the bubble legend title

margin.autoexpand

Logical; Whether extra space can be added to the margins to allow space for axis/legend/data labels or other chart elements.

margin.top

Margin between plot area and the top of the graphic in pixels

margin.bottom

Margin between plot area and the bottom of the graphic in pixels

margin.left

Margin between plot area and the left of the graphic in pixels

margin.right

Margin between plot area and the right of the graphic in pixels

grid.show

Logical; whether to show grid lines.

y.title

Character, y-axis title; defaults to chart input values; to turn off set to "FALSE".

y.title.font.color

y-axis title font color as a named color in character format (e.g. "black") or a hex code.

y.title.font.family

Character; y-axis title font family

y.title.font.size

Integer; y-axis title font size

y.line.width

y-axis line width in pixels (0 = no line).

y.line.color

y-axis line color as a named color in character format (e.g. "black") or a hex code.

y.tick.mark.length

Length of tick marks in pixels. Ticks are only shown when y.line.width > 0.

y.tick.mark.color

Color of tick marks (default transparent).

y.bounds.minimum

Minimum of range for plotting; For a date axis this should be supplied as a date string. For a categorical axis, the index of the category (0-based) should be used.

y.bounds.maximum

Maximum of range for plotting; NULL = no manual range set.

y.tick.distance

Distance between tick marks. Requires that y.bounds.minimum and y.bounds.maximum have been set.

y.tick.maxnum

Maximum number of ticks shown on the axis. This setting is ignored if y.tick.distance is set or if the axis is categorical

y.zero.line.width

Width in pixels of zero line;

y.zero.line.color

Color of horizontal zero line as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

y.zero.line.dash

Line type of y zero line. Can be one of 'Solid', 'Dot', 'Dash'.

y.grid.width

Width of y-grid lines in pixels; 0 = no line

y.grid.color

Color of y-grid lines as a named color in character format (e.g. "black") or a hex code.

y.grid.dash

Line type of y grid line. Can be one of 'Solid', 'Dot', 'Dash'.

y.tick.show

Whether to display the y-axis tick labels

y.tick.suffix

y-axis tick label suffix

y.tick.prefix

y-axis tick label prefix

y.tick.format

A string representing a d3 formatting code. See https://github.com/d3/d3/blob/master/API.md#number-formats-d3-format

y.hovertext.format

A string representing a d3 formatting code See https://github.com/d3/d3/blob/master/API.md#number-formats-d3-format

y.tick.font.color

y-axis tick label font color as a named color in character format (e.g. "black") or an a hex code.

y.tick.font.family

Character; y-axis tick label font family

y.tick.font.size

Integer; y-axis tick label font size

x.title

Character, x-axis title; defaults to chart input values; to turn off set to "FALSE".

x.title.font.color

x-axis title font color as a named color in character format (e.g. "black") or an a hex code.

x.title.font.family

Character; x-axis title font family

x.title.font.size

Integer; x-axis title font size

x.line.width

x-axis line in pixels, 0 = no line

x.line.color

x-axis line color as a named color in character format (e.g. "black") or a hex code.

x.tick.mark.length

Length of tick marks in pixels.

x.tick.mark.color

Color of tick marks.

x.bounds.minimum

Minimum of range for plotting; For a date axis this should be supplied as a date string. For a categorical axis, the index of the category (0-based) should be used.

x.bounds.maximum

Maximum of range for plotting; NULL = no manual range set. Must be greater than x.bounds.minimum

x.tick.distance

Tick mark distance in x-axis units between minimum and maximum for plotting; NULL = no manual range set.

x.tick.maxnum

Maximum number of ticks shown on the axis. It defaults to 11 which gives the same output from plotly as NULL. This setting is ignored if x.tick.distance is set or if the axis is categorical

x.zero.line.width

Width in pixels of zero line.

x.zero.line.color

Color of horizontal zero (origin) line as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

x.zero.line.dash

Line type of x zero line. Can be one of 'Solid', 'Dot', 'Dash'.

x.grid.width

Width of y-grid lines in pixels; 0 = no line

x.grid.color

Color of y-grid lines as a named color in character format (e.g. "black") or a hex code.

x.grid.dash

Line type of x grid line. Can be one of 'Solid', 'Dot', 'Dash'.

x.tick.show

Whether to display the x-axis tick labels

x.tick.suffix

x-axis tick label suffix

x.tick.prefix

x-axis tick label prefix

x.tick.format

A string representing a d3 formatting code. See https://github.com/mbostock/d3/wiki/Formatting#numbers

x.hovertext.format

A string representing a d3 formatting code. See https://github.com/mbostock/d3/wiki/Formatting#numbers

x.tick.angle

x-axis tick label angle in degrees. 90 = vertical; 0 = horizontal

x.tick.font.color

X-axis tick label font color as a named color in character format (e.g. "black") or an a hex code.

x.tick.font.family

Character; x-axis tick label font family

x.tick.font.size

Integer; x-axis tick label font size

x.tick.label.wrap

Logical; whether to wrap long labels on the x-axis.

x.tick.label.wrap.nchar

Integer; number of characters in each line when label.wrap is TRUE.

hovertext.font.family

Font family of hover text.

hovertext.font.size

Font size of hover text.

marker.size

Size in pixels of marker. This is overriden if scatter.sizes is provided, but used for the legend if scatter.colors.as.categorical.

swap.x.and.y

Swap the x and y axis around on the chart.

legend.bubbles.show

Logical; show legend for bubble sizes.

color.scale.show

is the toggle to show the color scale bar.

label.auto.placement

Logical; whether the scatter plot labels are positioned automatically to reduce overlap.

quadrants.show

Whether to show quadrants (including midpoint lines)

x.midpoint.type

One of "Average", "Median", "Calculation" or "Value"

x.midpoint.input

Input when "Calculation" is selected for x.midpoint.type

x.midpoint.value

Value when "Value" is selected for x.midpoint.type. Can be numeric or string of a number.

y.midpoint.type

One of "Average", "Median", "Calculation" or "Value"

y.midpoint.input

Input when "Calculation" is selected for y.midpoint.type

y.midpoint.value

Value when "Value" is selected for y.midpoint.type. Can be numeric or string of a number.

x.midpoint.line.color

x midpoint line color

x.midpoint.line.dash

x midpoint line type. Can be one of 'Solid', 'Dot', 'Dash'

x.midpoint.line.width

x midpoint line width in pixels

y.midpoint.line.color

y midpoint line color

y.midpoint.line.dash

y midpoint line type. Can be one of 'Solid', 'Dot', 'Dash'

y.midpoint.line.width

y midpoint line width in pixels

quadrant.top.left.color

Color of the top left quadrant

quadrant.top.right.color

Color of the top right quadrant

quadrant.bottom.left.color

Color of the bottom left quadrant

quadrant.bottom.right.color

Color of the bottom right quadrant

quadrant.top.left.title

Title to show for the top left quadrant

quadrant.top.left.title.font.family

Font family of the top left quadrant title

quadrant.top.left.title.font.color

Font color of the top left quadrant title

quadrant.top.left.title.font.size

Font size of the top left quadrant title

quadrant.top.right.title

Title to show for the top right quadrant

quadrant.top.right.title.font.family

Font family of the top right quadrant title

quadrant.top.right.title.font.color

Font color of the top right quadrant title

quadrant.top.right.title.font.size

Font size of the top right quadrant title

quadrant.bottom.left.title

Title to show for the bottom left quadrant

quadrant.bottom.left.title.font.family

Font family of the bottom left quadrant title

quadrant.bottom.left.title.font.color

Font color of the bottom left quadrant title

quadrant.bottom.left.title.font.size

Font size of the bottom left quadrant title

quadrant.bottom.right.title

Title to show for the bottom right quadrant

quadrant.bottom.right.title.font.family

Font family of the bottom right quadrant title

quadrant.bottom.right.title.font.color

Font color of the bottom right quadrant title

quadrant.bottom.right.title.font.size

Font size of the bottom right quadrant title

plot.border.show

Boolean toggle to show border around plot area. If this is true, then plot.border.* overrides x.line.* and y.line.*.

plot.border.color

Color of border around plot area (Default is black).

plot.border.width

Width of border around plot area in px (Default is 1).

fixed.aspect

Whether of not to force the x and y axis to be at the same scale. Default to FALSE. Cannot be guarenteed if any of the axis bounds are set.

Value

an HTML widget for "leaflet" or a "plotly" object.

Examples

z <- structure(c(1L, 2L, 3L, 4L, 5L, 2L, 3L, 4L, 5L, 6L),  .Dim = c(5L, 2L),
      .Dimnames = list(c("T", "U", "V", "W", "X"), c("A", "B")))
Column(z, type="Stacked Column")

Displayr/flipStandardCharts documentation built on Feb. 28, 2025, 4:36 p.m.