man-roxygen/getset-cell.R

In hughjonesd/huxtable: Easily Create and Style Tables for LaTeX, HTML and Other Formats

<%
more_alias_str <- ''
if (exists('morealiases')) {
  morealiases <- strsplit(morealiases, ' ')[[1]]
  more_alias_str <- c(outer(morealiases, c('', '<-'), paste0))
  more_alias_str <- c(more_alias_str,
        sprintf('set_%s', morealiases),
        sprintf('map_%s', morealiases))
  more_alias_str <- paste(more_alias_str, collapse = ' ')
}

default_property <- huxtable::get_default_properties(attr_name)[[1]]
if (is.list(default_property)) {
  default_property <- default_property[[1]]
}
if (typeof(default_property) == "character") {
  default_property <- sprintf("\"%s\"", default_property)
}

# this is the function default
default_str <- if (exists("default")) paste("=", default) else ""

%>

#' @usage
#' <%= attr_name %>(ht)
#' <%= attr_name %>(ht) <- value
#' set_<%= attr_name %>(ht, row, col, value <%= default_str %>)
#' map_<%= attr_name %>(ht, row, col, fn)
#'
#' @param ht A huxtable.
#' @param row A row specifier. See [rowspecs] for details.
#' @param col An optional column specifier.
#' @param fn A mapping function. See [mapping-functions] for details.
#' @param value <%= value_param_desc %>
#'   <% if (! exists('NA_does_not_reset')) {%>
#'   Set to `NA` to reset to the default, which is `<%= default_property %>`.
#'   <% } else { %>
#'   Note that setting to `NA` does not reset to the default.
#'   <% } %>
#'
#' @return `<%= attr_name %>()` returns the `<%= attr_name %>` property.
#' `set_<%= attr_name %>()` returns the modified huxtable.
#'
#' @aliases <%= attr_name %><- set_<%= attr_name %> map_<%= attr_name %> <%= more_alias_str %>
#' @name <%= attr_name %>