R/inherit_scplot.R

In jazznbass/scplot: Plot Function for Single-Case Data Frames

#' Dummy function to inherit global descriptions of parameters
#'
#' @param object An scplot object (class `scplot`) returned from the `scplot()`
#'   function.
#' @param label A Character vector with text labels.
#' @param labels A Character vector with text labels.
#' @param color A character string or a number defining the color of an element.
#' @param size Text size relative to the base text size.
#' @param width Line width.
#' @param hjust Horizontal justification (in \[0,1\])
#' @param vjust Vertical justification (in \[0,1\])
#' @param angle Angle (in \[0,360\])
#' @param face Font face (`"plain", "italic", "bold", "bold.italic"`)
#' @param linewidth A number with the width of the line.
#' @param linetype A character string with the line type: `"solid", "dashed",
#'   "dotted"`
#' @param shape Number. See `pch` graphical parameter on `par` help page
#'   [par()].
#' @param text List with text parameters (`"family", "face", "colour", "size",
#'   "hjust", "vjust", "angle", "lineheight", "margin"`). See [element_text()].
#' @param background A list with background styling arguments (fill, color,
#'   size, linetype).
#' @param case Numerical vector with the case number or character string. `case
#'   = "all"` for all cases.
#' @param variable Name of the dataline variable to apply the style.
#' @param point A list with point parameters (`"colour", "size", "shape"`). See
#'   [element_point()].
#' @param line List with line parameters (`"colour", "linewidth", "linetype",
#'   "lineend", "arrow"`). See [element_line()].
#' @param ... Further styling arguments: color, size, face, family, hjust,
#'   vjust, lineheight, angle, linetype, lineend, arrow, fill, margin.
#' @keywords internal
.inherit_scplot <- function(object,label, labels, color, size,
                            linewidth, hjust, vjust,
                            angle, width, face,linetype, shape, text,
                            background, case, variable, point, line, ...) {

}