1. structToolbox
  2. man-roxygen
  3. model_predict.R
Browse code

use class contructors and...

...rename all function with dot to underscore
replace dataset with DatasetExperiment

Gavin Rhys Lloyd authored on 17/12/2019 15:48:01
Showing 1 changed files
man-roxygen/model_predict.R
History View file @ 8db793a
... ... 
@@ -1 +1 @@
1 
-#' @rdname model.predict
1 
+#' @rdname model_predict
Browse code

update documentation and roxygen templates

grlloyd authored on 23/09/2019 14:26:49
Showing 1 changed files
man-roxygen/model_predict.R
History View file @ 28dfb67
... ... 
@@ -1,12 +1 @@
1 
-#' Model prediction
2 
-#'
3 
-#' Apply a model using the input dataset. Assumes the model is trained
4 
-#' first.
5 
-#' @param M a model object
6 
-#' @param D a dataset object
7 
-#' @return Returns a modified model object
8 
-#' @rdname predict
9 
-#' @examples
10 
-#' M = example_model()
11 
-#' M = model.predict(M,iris_dataset())
12 
-#'
1 
+#' @rdname model.predict
Browse code

use model_train roxygen template

grlloyd authored on 23/09/2019 13:04:49
Showing 1 changed files
man-roxygen/model_predict.R
History View file @ 5d21f82
... ... 
@@ -6,7 +6,6 @@
6 6 
 #' @param D a dataset object
7 7 
 #' @return Returns a modified model object
8 8 
 #' @rdname predict
9 
-#' @export
10 9 
 #' @examples
11 10 
 #' M = example_model()
12 11 
 #' M = model.predict(M,iris_dataset())
Browse code

add roxygen templates

grlloyd authored on 23/09/2019 13:02:20
Showing 1 changed files
man-roxygen/model_predict.R
History View file @ fc54017
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,13 @@
1 
+#' Model prediction
2 
+#'
3 
+#' Apply a model using the input dataset. Assumes the model is trained
4 
+#' first.
5 
+#' @param M a model object
6 
+#' @param D a dataset object
7 
+#' @return Returns a modified model object
8 
+#' @rdname predict
9 
+#' @export
10 
+#' @examples
11 
+#' M = example_model()
12 
+#' M = model.predict(M,iris_dataset())
13 
+#'