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
... ...
@@ -1,12 +1,12 @@
1 1
 #' Model prediction
2 2
 #'
3
-#' Apply a model using the input dataset. Assumes the model is trained
3
+#' Apply a model using the input DatasetExperiment. Assumes the model is trained
4 4
 #' first.
5 5
 #' @param M a model object
6
-#' @param D a dataset object
6
+#' @param D a DatasetExperiment object
7 7
 #' @return Returns a modified model object
8 8
 #' @examples
9 9
 #' M = example_model()
10
-#' M = model.predict(M,iris_dataset())
11
-#' @name model.predict
10
+#' M = model_predict(M,iris_DatasetExperiment())
11
+#' @name model_predict
12 12
 NULL
Browse code

update documentation and roxygen templates

grlloyd authored on 23/09/2019 14:26:49
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,12 @@
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
+#' @examples
9
+#' M = example_model()
10
+#' M = model.predict(M,iris_dataset())
11
+#' @name model.predict
12
+NULL