cog_spec: Cognostic Specification

Description Usage Arguments Value Examples

View source: R/cog_spec.R

Description

Cognostic Specification

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
cog_spec(bivariate_continuous = TRUE, bivariate_counts = TRUE,
  bivariate_step = TRUE, boxplot = TRUE, density_2d_continuous = TRUE,
  density_continuous = TRUE, grouped_counts = TRUE,
  grouped_testing = TRUE, hex_counts = TRUE, histogram_counts = TRUE,
  linear_model = TRUE, loess_model = TRUE, pairwise_counts = TRUE,
  quantile_quantile = TRUE, scagnostics = TRUE, smooth_line = TRUE,
  square_counts = TRUE, univariate_continuous = TRUE,
  univariate_counts = TRUE, univariate_discrete = TRUE, ...,
  .keep_layer = TRUE)

as_cog_specs(p, specs)

Arguments

bivariate_continuous, bivariate_counts, bivariate_step, boxplot, density_2d_continuous, density_continuous, grouped_counts, grouped_testing, hex_counts, histogram_counts, linear_model, loess_model, pairwise_counts, quantile_quantile, scagnostics, smooth_line, square_counts, univariate_continuous, univariate_counts, univariate_discrete

names of cognostic groups to calculate. The boolean value (TRUE) supplied to each argument determines if the value should be displayed if possible or removed if possible.

...

ignored. Will cause error if any are supplied

.keep_layer

boolean (TRUE) that determines if the layer should be kept at all

p

plot object in question

specs

list of cog_spec outputs for each layer of the plot object

Value

cognostic specification that determines which cogs are added or removed if possible

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
# example cog specifications
# display like normal
cog_spec(); TRUE
# remove scagnostics
cog_spec(scagnostics = FALSE)
# remove layer
cog_spec(.keep_layer = FALSE); FALSE

# set up data
p <- ggplot2::qplot(Sepal.Length, Sepal.Width, data = iris, geom = c("point", "smooth"))
dt <- tibble::data_frame(panel = list(p))

# compute cognostics like normal
add_panel_cogs(dt)

# do not compute scagnostics for geom_point cognostics
# compute geom_smooth cognostics
add_panel_cogs(dt, spec = list(cog_spec(scagnostics = FALSE), TRUE))

# do not compute scagnostics for geom_point cognostics
# do not compute geom_smooth cognostics
add_panel_cogs(dt, spec = list(cog_spec(scagnostics = FALSE), FALSE))

schloerke/autocog documentation built on June 26, 2018, 3:21 p.m.