Roxygen2 – how to properly document S3 methods

by

As of roxygen2 >3.0.0, you only need @export:

#' A description of MyHappyFunction
#'
#' A details of MyHappyFunction
#'
#' @title MyHappyFunction: The my happy function
#' @param x numeric number
#' @param ... other arguments
#' @examples
#' a <- 1
#' class(a) <- "lm"
#' MyHappyFunction(a)
#' @export
MyHappyFunction <- function(x, ...){
  UseMethod("MyHappyFunction")
}

#' @rdname MyHappyFunction
#' @export
MyHappyFunction.lm = function(x, ...) {
  # do some magic
}

#' @rdname MyHappyFunction
#' @export
MyHappyFunction.default = function(x, ...) {
  # do some magic
}

But since you’re not actually documenting the methods, the following is
sufficient:

#' A description of MyHappyFunction
#'
#' A details of MyHappyFunction
#'
#' @title MyHappyFunction: The my happy function
#' @param x numeric number
#' @param ... other arguments
#' @examples
#' a <- 1
#' class(a) <- "lm"
#' MyHappyFunction(a)
#' @export
MyHappyFunction <- function(x, ...){
  UseMethod("MyHappyFunction")
}

#' @export
MyHappyFunction.lm = function(x, ...) {
  # do some magic
}

#' @export
MyHappyFunction.default = function(x, ...) {
  # do some magic
}

More Related Contents:

  1. How can I document data sets with roxygen?
  2. Importing two functions with same name using roxygen2
  3. Exporting non-S3-methods with dots in the name using roxygen2 v4
  4. How to export S3 method so it is available in namespace?
  5. generate markdown comments within for loop
  6. How to properly document S4 methods using roxygen2
  7. How to properly document a S3 method of a generic from a different package, using Roxygen?
  8. Possible to create Rd help files for objects not in a package?
  9. Loop through a R matrix row-wise and print elements [duplicate]
  10. i want to simulate it 500 times but this function gives 187 correct values but after 187 values it give NA values
  11. Reshape three column data frame to matrix (“long” to “wide” format) [duplicate]
  12. Create counter with multiple variables [duplicate]
  13. Conditional replacement of values in a data.frame
  14. Multiply rows of matrix by vector?
  15. How to find the highest value of a column in a data frame in R?
  16. Seeing if data is normally distributed in R
  17. Floating point less-than-equal comparisons after addition and substraction
  18. Remove groups with less than three unique observations
  19. draw the sum value above the stacked bar in ggplot2
  20. How to initialize empty data frame (lot of columns at the same time) in R
  21. Merge three different columns into a date in R
  22. installation path not writable R, unable to update packages
  23. Reading multiple files into multiple data frames
  24. How to add multiple captions in ggplot2 outside of the main graph area
  25. R sum a variable by two groups [duplicate]
  26. R: xtable and dates
  27. Using R to read out excel-colorinfo
  28. Existing function for seeing if a row exists in a data frame?
  29. Convert comma separated string to integer in R
  30. Interpolating timeseries

Leave a Comment