Merge pull request #153 from louisaslett/master

Fix documentation errors for CRAN

Author: jakobbossek

DESCRIPTION

@@ -48,5 +48,5 @@ Suggests:
     covr
 ByteCompile: yes
 LinkingTo: Rcpp, RcppArmadillo
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.3
 Encoding: UTF-8

R/addCountingWrapper.R

@@ -1,5 +1,5 @@
 #' @title
-#' Return a function which counts its function evaluations.
+#' Return a function which counts its function evaluations
 #'
 #' @description
 #' This is a counting wrapper for a \code{smoof_function}, i.e., the returned function

R/addLoggingWrapper.R

@@ -1,5 +1,5 @@
 #' @title
-#' Return a function which internally stores x or y values.
+#' Return a function which internally stores x or y values
 #'
 #' @description
 #' Often it is desired and useful to store the optimization path, i.e., the evaluated

R/computeExpectedRunningTime.R

@@ -1,14 +1,14 @@
 #' @title
-#' Compute the Expected Running Time (ERT) performance measure.
+#' Compute the Expected Running Time (ERT) performance measure
 #'
 #' @description
 #' The functions can be called in two different ways
 #' \itemize{
-#'   \item{1. Pass a vector of function evaluations and a logical vector which
-#'   indicates which runs were successful (see details).}
-#'   \item{2. Pass a vector of function evaluation, a vector of reached target
+#'   \item 1. Pass a vector of function evaluations and a logical vector which
+#'   indicates which runs were successful (see details).
+#'   \item 2. Pass a vector of function evaluation, a vector of reached target
 #'   values and a single target value. In this case the logical vector of
-#'   option 1. is computed internally.}
+#'   option 1. is computed internally.
 #' }
 #'
 #' @details The Expected Running Time (ERT) is one of the most popular performance

R/conversion.R

@@ -1,5 +1,5 @@
 #' @title
-#' Conversion between minimization and maximization problems.
+#' Conversion between minimization and maximization problems
 #'
 #' @description
 #' We can minimize f by maximizing -f. The majority of predefined objective functions

R/doesCountEvaluations.R

@@ -1,5 +1,5 @@
 #' @title
-#' Check whether the function is counting its function evaluations.
+#' Check whether the function is counting its function evaluations
 #'
 #' @description
 #' In this case, the function is of type \code{smoof_counting_function} or it

R/filterFunctionsByTags.R

@@ -1,5 +1,5 @@
 #' @title
-#' Get a list of implemented test functions with specific tags.
+#' Get a list of implemented test functions with specific tags
 #'
 #' @description
 #' Single objective functions can be tagged, e.g., as unimodal. Searching for all

R/getAvailableTags.R

@@ -1,5 +1,5 @@
 #' @title
-#' Returns a character vector of possible function tags.
+#' Returns a character vector of possible function tags
 #'
 #' @description
 #' Test function are frequently distinguished by characteristic high-level properties,

R/getBoxConstraints.R

@@ -1,4 +1,4 @@
-#' Returns lower box constraints for a Smoof function.
+#' Returns lower box constraints for a Smoof function
 #'
 #' @template arg_smoof_function
 #' @return [\code{numeric}]
@@ -18,7 +18,7 @@ getLowerBoxConstraints.smoof_wrapped_function = function(fn) {
   return(getLowerBoxConstraints(getWrappedFunction(fn)))
 }
 
-#' Return upper box constaints.
+#' Return upper box constraints
 #'
 #' @template arg_smoof_function
 #' @return [\code{numeric}]

R/getDescription.R

@@ -1,4 +1,4 @@
-#' Returns the description of the function.
+#' Returns the description of the function
 #'
 #' @template arg_smoof_function
 #' @return [\code{character(1)}]