R/tag-format.r

In hadley/roxygen3: In-source documentation for R

#' @@format: describe format of data.
#'
#' If not specified, \code{str} will be used to generate a brief description.
#'
#' @tagUsage @@format A data.frame with 12 columns and 3 rows
setClass("FormatTag", contains = "Tag")

setMethod("defaultTag", c("FormatTag", "DataObject"),
  function(tag, object) {
    out <- str_c(capture.output(str(object@value, max.level = 1)),
      collapse = "\n")
    new("FormatTag", text = out)
  }
)

setMethod("writeRd", "FormatTag", function(object) {
  RdCommand("format", object@text)
})