Data documentation example

R/data.R

@@ -0,0 +1,30 @@
+
+#' Test data - short title
+#'
+#' @description What the dataset is
+#'
+#' @usage data(test_data) or my_function(test_data)
+#'
+#' @format Describe the format or structure of the data and what it is. E.g. a
+#'   data frame with 2 columns of some random numbers.
+#'
+#' @details Optional. More details about the data. E.g. what each column is,
+#'   what you might use it for, which functions it goes with, etc. Delete
+#'   section if not using.
+#'
+#' @md
+#'
+#' @source Who added it or where it came from. E.g. Data comes from
+#'   [ICES](http://www.ices.dk) (this is how you add a weblink)
+#'
+#' @seealso [`my_function`] - Optional link to the function or functions it goes
+#'   with. Delete section if not using.
+#'
+#' @examples
+#' # Example of how to use the data in a function (optional, but useful)
+#' my_function(test_data)
+"test_data" # THIS PART IS IMPORTANT - name of the dataset in quotes without the ".rda"
+
+
+# Documentation for other datasets get added below this one - the order is not important.
+#