depict-methods: Depict (plot) features of model module data

In ready4-dev/youthvars: Describe and Validate Youth Mental Health Economic Datasets

Depict (plot) features of model module data

Description

depict method applied to YouthvarsSeries

depict method applied to YouthvarsProfile

Usage

## S4 method for signature 'YouthvarsSeries'
depict(
  x,
  x_vars_chr = character(0),
  y_vars_chr = character(0),
  z_vars_chr = character(0),
  arrange_1L_lgl = FALSE,
  arrange_args_ls = list(),
  as_percent_1L_lgl = FALSE,
  colours_chr = c("#de2d26", "#fc9272"),
  drop_legend_1L_lgl = FALSE,
  drop_missing_1L_lgl = FALSE,
  drop_ticks_1L_lgl = FALSE,
  fill_single_1L_lgl = FALSE,
  flip_1L_lgl = F,
  line_1L_chr = "black",
  position_xx = NULL,
  recode_lup_r3 = ready4show::ready4show_correspondences(),
  significance_1L_lgl = F,
  significance_args_ls = list(),
  style_1L_chr = ready4use::get_styles(),
  titles_chr = character(0),
  type_1L_chr = c("ggsci", "manual", "viridis", "by_time"),
  x_labels_chr = character(0),
  y_labels_chr = character(0),
  z_labels_chr = character(0),
  what_1L_chr = ready4use::get_journal_plot_fn("names"),
  label_fill_1L_chr = deprecated(),
  labels_chr = deprecated(),
  var_nms_chr = deprecated(),
  y_label_1L_chr = deprecated(),
  y_scale_scl_fn = deprecated(),
  ...
)

## S4 method for signature 'YouthvarsProfile'
depict(
  x,
  x_vars_chr = character(0),
  y_vars_chr = character(0),
  z_vars_chr = character(0),
  arrange_1L_lgl = FALSE,
  arrange_args_ls = list(),
  as_percent_1L_lgl = FALSE,
  colours_chr = c("#de2d26", "#fc9272"),
  drop_legend_1L_lgl = FALSE,
  drop_missing_1L_lgl = FALSE,
  drop_ticks_1L_lgl = FALSE,
  fill_single_1L_lgl = FALSE,
  flip_1L_lgl = F,
  line_1L_chr = "black",
  position_xx = NULL,
  recode_lup_r3 = ready4show::ready4show_correspondences(),
  significance_1L_lgl = F,
  significance_args_ls = list(),
  style_1L_chr = ready4use::get_styles(),
  titles_chr = character(0),
  type_1L_chr = c("ggsci", "manual", "viridis"),
  x_labels_chr = character(0),
  y_labels_chr = character(0),
  z_labels_chr = character(0),
  what_1L_chr = ready4use::get_journal_plot_fn("names"),
  labels_chr = deprecated(),
  var_nms_chr = deprecated(),
  y_label_1L_chr = deprecated(),
  y_scale_scl_fn = deprecated(),
  ...
)

Arguments

x	An object of class YouthvarsProfile
x_vars_chr	X variables (a character vector), Default: character(0)
y_vars_chr	Y variables (a character vector), Default: character(0)
z_vars_chr	Z variables (a character vector), Default: character(0)
arrange_1L_lgl	Arrange (a logical vector of length one), Default: FALSE
arrange_args_ls	Arrange arguments (a list), Default: list()
as_percent_1L_lgl	As percent (a logical vector of length one), Default: FALSE
colours_chr	Colours (a character vector), Default: c("#de2d26", "#fc9272")
drop_legend_1L_lgl	Drop legend (a logical vector of length one), Default: FALSE
drop_missing_1L_lgl	Drop missing (a logical vector of length one), Default: FALSE
drop_ticks_1L_lgl	Drop ticks (a logical vector of length one), Default: FALSE
fill_single_1L_lgl	Fill single (a logical vector of length one), Default: FALSE
flip_1L_lgl	Flip (a logical vector of length one), Default: F
line_1L_chr	Line (a character vector of length one), Default: 'black'
position_xx	Position (an output object of multiple potential types), Default: NULL
recode_lup_r3	Recode (a ready4 submodule extension of lookup table), Default: ready4show::ready4show_correspondences()
significance_1L_lgl	Significance (a logical vector of length one), Default: F
significance_args_ls	Significance arguments (a list), Default: list()
style_1L_chr	Style (a character vector of length one), Default: ready4use::get_styles()
titles_chr	Titles (a character vector), Default: character(0)
type_1L_chr	Type (a character vector of length one), Default: c("ggsci", "manual", "viridis")
x_labels_chr	X labels (a character vector), Default: character(0)
y_labels_chr	Y labels (a character vector), Default: character(0)
z_labels_chr	Z labels (a character vector), Default: character(0)
what_1L_chr	What (a character vector of length one), Default: ready4use::get_journal_plot_fn("names")
label_fill_1L_chr	Label fill (a character vector of length one), Default: deprecated()
labels_chr	Labels (a character vector), Default: deprecated()
var_nms_chr	Variable names (a character vector), Default: deprecated()
y_label_1L_chr	Y label (a character vector of length one), Default: deprecated()
y_scale_scl_fn	Y scale scale (a function), Default: deprecated()
...	Additional arguments

Value

Plot (an output object of multiple potential types)

Plot (an output object of multiple potential types)

ready4-dev/youthvars documentation built on Nov. 15, 2024, 6:02 a.m.