Added examples and returns in documentation

R/MetaNLP.R

@@ -49,6 +49,10 @@ setClass("MetaNLP", representation(data_frame = "data.frame"))
 #' values are either "yes" and "no" or "include" and "exclude" or "maybe".
 #' The value "maybe" is handled as a "yes"/"include".
 #'
+#' @examples
+#' \dontrun{
+#' obj <- MetaNLP("test_data.csv")}
+#'
 #' @note
 #' To ensure correct processing of the data when there are special characters
 #' (e.g. "é" or "ü"), make sure that the csv-file is correctly encoded
@@ -169,6 +173,7 @@ setMethod("show", signature("MetaNLP"),
 #' obj <- MetaNLP("test_data.csv")
 #' plot(obj)}
 #'
+#' @return nothing
 #' @export
 setMethod("plot", signature("MetaNLP", y = "missing"),
           function(x,  y = NULL, max.words = 70,

R/useful_functions.R

@@ -115,6 +115,7 @@ setGeneric("write_csv", function(object, ...) {
 #' write_csv(obj2, path = "foo.csv")
 #' }
 #'
+#' @return nothing
 #'
 #' @rdname write_csv
 #' @export
@@ -167,6 +168,8 @@ setMethod("write_csv", signature("MetaNLP"),
 #' to_test_obj <- read_test_data(obj, "path/to_test.csv")
 #' }
 #'
+#' @return An object of class MetaNLP
+#'
 #' @rdname read_test_data
 #' @export
 setGeneric("read_test_data", function(object, ...) {