Browse code

update documentation and roxygen templates

grlloyd authored on 23/09/2019 14:26:49
Showing 1 changed files
... ...
@@ -1,10 +1,2 @@
1
-#' Calculate metric
2
-#'
3
-#' @param obj a metric object
4
-#' @param value value
5
-#' @param ... additional inputs depending on object
6
-#' @rdname metric
7
-#' @examples
8
-#' MET = metric()
9
-#' calculate(MET)
10
-#'
1
+#' @rdname calculate
2
+
Browse code

use model_train roxygen template

grlloyd authored on 23/09/2019 13:04:49
Showing 1 changed files
... ...
@@ -4,7 +4,6 @@
4 4
 #' @param value value
5 5
 #' @param ... additional inputs depending on object
6 6
 #' @rdname metric
7
-#' @export
8 7
 #' @examples
9 8
 #' MET = metric()
10 9
 #' calculate(MET)
Browse code

add roxygen templates

grlloyd authored on 23/09/2019 13:02:20
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,11 @@
1
+#' Calculate metric
2
+#'
3
+#' @param obj a metric object
4
+#' @param value value
5
+#' @param ... additional inputs depending on object
6
+#' @rdname metric
7
+#' @export
8
+#' @examples
9
+#' MET = metric()
10
+#' calculate(MET)
11
+#'