Nothing
#' Make Title
#'
#' Make title attribute.
#' Generic, with methods
#' \code{\link{make_title.default}},
#' \code{\link{make_title.decorated}}, and
#' \code{\link{make_title.dvec}}.
#'
#' @param x object
#' @param ... passed arguments
#' @export
#' @keywords internal
#' @family deprecated
#' @family labels
#' @return see methods
#' @examples
#' # see methods
make_title <- function(x, ...)UseMethod('make_title')
#' Make Title for Decorated
#'
#' Make title for class 'decorated'.
##' Limits scope to requested variables, and then calls
#' class-specific methods for each.
#'
#' @param x object
#' @param ... optional names of variables to limit scope
#' @export
#' @keywords internal
#' @family labels
#' @return decorated
#' @examples
#' library(magrittr)
#' x <- data.frame(length = 1:10)
#' x %>%
#' decorate('length: [ Length, mm ]') %>%
#' resolve %>%
#' decorations
#'
make_title.decorated <- function(
x,
...
){
vars <- selected(x, ...)
args <- named(...)
for(var in vars){
# pass only named arguments
x[[var]] <- do.call(make_title, c(list(x[[var]]),args))
}
x
}
#' Make Title by Default
#'
#' Make title by default.
#' To be specific: this is the default method
#' for the generic function \code{\link{make_title}},
#' and it actually does nothing. Individual methods
#' are written for those classes where 'make title'
#' behavior is expected.
#'
#' @param x object
#' @param ... ignored
#' @export
#' @keywords internal
#' @family labels
#' @return same as x
make_title.default <- function(
x,
...
){
return(x)
}
#' Make Title for Decorated Vector
#'
#' Makes title for decorated vectors.
#' If option \code{with_title} is TRUE
#' and x has a 'units' attribute,
#' it adds the title attribute. See also
#' \code{\link{drop_title}} for coordinated use.
#' @param x dvec
#' @param ... ignored arguments
#' @param with_title whether to drop title
#' @export
#' @keywords internal
#' @family labels
#' @return dvec
#' @examples
#' library(magrittr)
#' 1 %>%
#' as_dvec(label = 'length', guide = 'mm') %>%
#' resolve
make_title.dvec <- function(
x,
...,
with_title = getOption('yamlet_with_title', TRUE)
){
stopifnot(length(with_title) == 1)
with_title <- as.logical(with_title)
if(with_title & 'units' %in% names(attributes(x))){
x <- append_units(x, ..., target = 'title')
}
x
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.