Fix documentation

imbs-hl · Jul 13, 2024 · baf179b · baf179b
1 parent 9f51441
commit baf179b
Show file tree

Hide file tree

Showing 20 changed files with 87 additions and 86 deletions.
diff --git a/R/Data.R b/R/Data.R
@@ -42,9 +42,9 @@ Data <- R6Class("Data",
                   #' @description
                   #' Retrieve a data subset for a given variable name and values, a data subset.
                   #'
-                  #' @param var_name `character(1)` \cr
+                  #' @param var_name (`character(1)`) \cr
                   #' Variable name of interest.
-                  #' @param value `vector(n)` \cr
+                  #' @param value (`vector(n)`) \cr
                   #' Values of interest.
                   #'
                   #' @return

diff --git a/R/TrainStudy.R b/R/TrainStudy.R
@@ -89,7 +89,7 @@ TrainStudy <- R6Class("TrainStudy",
                    #'
                    #' @param new_study (`NewData(1)`) \cr
                    #' Object of class [NewData].
-                   #' @param ind_subset (`vector(1)`) \cr
+                   #' @param ind_subset  (`vector(1)`) \cr
                    #' Subset of individuals IDs to be used for training.
                    #'
                    #' @return
@@ -201,7 +201,7 @@ TrainStudy <- R6Class("TrainStudy",
                    #' @description
                    #' Trains the current study. All leaners and the meta learner are trained.
                    #'
-                   #' @param ind_subset [`vector(1)`] \cr
+                   #' @param ind_subset (`vector(1)`) \cr
                    #' ID subset to be used for training.
                    #' @param resampling_method (`function(1)`) \cr
                    #' Function for internal validation.
@@ -231,9 +231,9 @@ TrainStudy <- R6Class("TrainStudy",
                    #' @description
                    #' Predicts a new study.
                    #'
-                   #' @param new_study `TrainStudy(1)` \cr
+                   #' @param new_study (`TrainStudy(1)`) \cr
                    #' A new study to be predicted.
-                   #' @param ind_subset `vector()` \cr
+                   #' @param ind_subset (`vector(1)`) \cr
                    #' Vector of IDs to be predicted.
                    #'
                    #' @return

diff --git a/man/Data.Rd b/man/Data.Rd
diff --git a/man/HashTable.Rd b/man/HashTable.Rd
diff --git a/man/Lrner.Rd b/man/Lrner.Rd
diff --git a/man/Model.Rd b/man/Model.Rd
diff --git a/man/NewData.Rd b/man/NewData.Rd
diff --git a/man/NewLayer.Rd b/man/NewLayer.Rd
diff --git a/man/NewMetaLayer.Rd b/man/NewMetaLayer.Rd
diff --git a/man/NewStudy.Rd b/man/NewStudy.Rd
diff --git a/man/PredictData.Rd b/man/PredictData.Rd
diff --git a/man/PredictLayer.Rd b/man/PredictLayer.Rd
diff --git a/man/PredictMetaLayer.Rd b/man/PredictMetaLayer.Rd
diff --git a/man/PredictStudy.Rd b/man/PredictStudy.Rd
diff --git a/man/TrainData.Rd b/man/TrainData.Rd
diff --git a/man/TrainLayer.Rd b/man/TrainLayer.Rd