I am trying to create a help file that services multiple data sets that are all similar. However, roxygen generates a sequence of text that says something like "An object of class...", but it makes my document (of many data sets) look messy to me. Is there a way to delete this?
I tried to make a simplified example of the problem. This is using three data sets (data1, data2, data3
). All three data sets have the same number of dimensions.
#' Example with multiple data sets
#'
#' The a description
#'
#' @format Simple format
#' @name multi_data
#' @keywords datasets
#'
"data1"
#' @rdname multi_data
"data2"
#' @rdname multi_data
"data3"
This is making the multi_data file look like:
You can add the line
#' @format NULL
before each of the @rdname
lines if you don't want any format text to be generated.