argument_dummy: argument_dummy

Description Usage Arguments

View source: R/documentation-dummies.R

Description

argument_dummy

Usage

1
argument_dummy(pt_alpha, pt_clr, pt_clrp, pt_clrsp, pt_size)

Arguments

pt_alpha

Numeric value. Specifies the degree of transparency of all points.

pt_clr

Character value. Specifies the color of all points.

pt_clrp

The color palette to be used if the specified variable displayed by color is categorical/discrete. Run validColorPalettes() to see valid input.

pt_clrsp

The color spectrum to be used if the specified variable displayed by color is continuous. Run validColorSpectra() to see valid input.

pt_size

Numeric value. Specifies the size of all points.

clrp

Character value. Specifies the color palette to be used to represent groups of discrete variables. Run validColorPalettes() to obtain valid input options.

clrp_adjust

Named character vector or NULL. If character, it adjusts the color palette that is used to represent the groups. Names of the input vector must refer to the group and the respective named element denotes the color with which to represent the group.

clrsp

Character value. Specifies the color spectrum to be used to represent continuous values of numeric variables. Run validColorSpectra() to obtain valid input options.

discrete_feature

Character value. Specifies the name of the grouping variable of interest. Use getGroupingOptions() to obtain all valid input options.

display_facets

Logical value. If set to TRUE the plot is split via ggplot2::facet_wrap() such that each variable gets it's own subplot.

display_points

Logical value. If set to TRUE points are used additionally to display the results.

display_title

Logical value. If set to TRUE an informative title is displayed.

scales, ncol, nrow

Given to ggplot2::facet_wrap(). Affects the way the subplots are displayed.

simplify

Logical. If set to TRUE the output list is simplified to a vector if possible. If set to FALSE a list is returned.

verbose

Logical. If set to TRUE informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)


kueckelj/celltracer documentation built on June 2, 2021, 6:37 a.m.