tests/testthat/testdoc/R/fundoc.R

In Rd2md: Markdown Reference Manuals

#' Bind multiple data frames by column
#'
#' @description
#' Bind any number of data frames by column, making a wider result.
#' This is similar to `do.call(cbind, dfs)`.
#'
#' Where possible prefer using a [join][left_join] to combine multiple
#' data frames. `bind_cols()` binds the rows in order in which they appear
#' so it is easy to create meaningless results without realising it.
#'
#' @param ... Data frames to combine. Each argument can either be a data frame,
#'   a list that could be a data frame, or a list of data frames.
#'   Inputs are [recycled][vctrs::theory-faq-recycling] to the same length,
#'   then matched by position.
#' @param .name_repair One of `"unique"`, `"universal"`, or
#'   `"check_unique"`. See [vctrs::vec_as_names()] for the meaning of these
#'   options.
#' @returns A data frame the same type as the first element of `...`.
#' @export
#' @examples
#' df1 <- tibble(x = 1:3)
#' df2 <- tibble(y = 3:1)
#' bind_cols(df1, df2)
#'
#' # Row sizes must be compatible when column-binding
#' try(bind_cols(tibble(x = 1:3), tibble(y = 1:2)))
bind_cols <- function(
  ...,
  .name_repair = c("unique", "universal", "check_unique", "minimal")
) ""

#' Function With User Defined Macro In Description
#'
#' @description
#' CRANpkg macro: \CRANpkg{mycranpkg}
#' @param Rd Object of class `Rd`
#' @return Some return value
fundoc_with_ud_macro <- function(Rd) ""

#' An S4 class to represent a bank account.
#'
#' @slot balance A length-one numeric vector
#' @examples
#' myacc <- Account(1000)
Account <- setClass("Account",
  slots = list(balance = "numeric")
)

#' This is my Person class
#'
#' @description
#' Person class description
#' @field name Name of the person
#' @field hair Hair colour
#'
#' @examples
#' Person$new(name="Bill", hair="Blond")
#' @export
Person <- R6::R6Class("Person",
  public = list(
    name = NULL,
    hair = NULL,

    #' @description
    #' Create a person
    #' @param name Name of the person
    #' @param hair Hair colour
    initialize = function(name = NA, hair = NA) {
      self$name <- name
      self$hair <- hair
    },

    #' @description Set hair
    #' @param val Hair colour
    set_hair = function(val) {
      self$hair <- val
    }
  )
)