R/Robot-helper-template.R

#' % Comment some things...
#'
#' @name RH-template-package
#'
#' @title Robot helper template
#'
#' @description
#' A robot helper template for roxygen2.
#'
#' Add some features
#'
#' A robot helper template for roxygen2.
#'
#' @usage
#' add_numbers(x)
#' add_numbers(x, y)
#'
#' @param x A description of the parameter 'x'. The
#'   description can span multiple lines.
#' @param y A description of the parameter 'y'.
#'
#'
#' @details
#' Details for some things.
#'
#' @return
#' Return or output of function \code{add_numbers}.
#'
#' @section A Custom Section:
#' Text accompanying the custom section.
#'
#' @note
#'   \enumerate{
#'     \item Note 1.
#'     \item Note 2.
#'   }
#'
#' @author
#'   \describe{
#'     \item{}{Trát Quang Thụy}
#'   }
#'
#' @source
#'   \itemize{
#'     \item \href{https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html}{https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html}
#'   }
#'
#' @references
#'   \describe{
#'     \item{label-1}{text-1}
#'     \item{label-2}{text-2}
#'   }
#'
#' @seealso
#' \itemize{
#'   \item \href{https://github.com/BabyMouse/Rb3m}{GitHub: https://github.com/BabyMouse/Rb3m}
#'   \item \href{http://r-pkgs.had.co.nz/man.html}{http://r-pkgs.had.co.nz/man.html}
#' }
#'
#' @examples
#' add_numbers(1, 2) ## returns 3
#'
#' ## don't run this in calls to 'example(add_numbers)'
#' \dontrun{
#'    add_numbers(2, 3)
#' }
#'
#' ## don't test this during 'R CMD check'
#' \donttest{
#'    add_numbers(4, 5)
#' }
#'
NULL
BabyMouse/Rb3m documentation built on June 4, 2020, 11:21 a.m.