Fix documentation errors for CRAN

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)}]

R/getGlobalOptimum.R

@@ -1,11 +1,11 @@
-#' Returns the global optimum and its value.
+#' Returns the global optimum and its value
 #'
 #' @template arg_smoof_function
 #' @return [\code{list}] List containing the following entries:
-#' \itemize{
-#'   \item{param [\code{list}]} {Named list of parameter value(s).}
-#'   \item{value [\code{numeric(1)}]} {Optimal value.}
-#'   \item{is.minimum [\code{logical(1)}]} {Is the global optimum a minimum or maximum?}
+#' \describe{
+#'   \item{param [\code{list}]}{Named list of parameter value(s).}
+#'   \item{value [\code{numeric(1)}]}{Optimal value.}
+#'   \item{is.minimum [\code{logical(1)}]}{Is the global optimum a minimum or maximum?}
 #' }
 #' @note Keep in mind, that this method makes sense only for single-objective target function.
 #' @export

R/getID.R

@@ -1,5 +1,5 @@
 #' @title
-#' Returns the ID / short name of the function.
+#' Returns the ID / short name of the function
 #' 
 #' @description
 #' Returns the ID / short name of the function or \code{NA} if no ID is set.

R/getLocalOptimum.R

@@ -1,13 +1,13 @@
 #' @title
-#' Returns the local optima of a single objective smoof function.
+#' Returns the local optima of a single objective smoof function
 #'
 #' @description
 #' This function returns the parameters and objective values of
 #' all local optima (including the global one).
 #'
 #' @template arg_smoof_function
 #' @return [\code{list}] List containing the following entries:
-#' \itemize{
+#' \describe{
 #'   \item{param [\code{list}]}{List of parameter values per local optima.}
 #'   \item{value [\code{list}]}{List of objective values per local optima.}
 #'   \item{is.minimum [\code{logical(1)}]}{Are the local optima minima or maxima?}

R/getLoggedValues.R

@@ -1,4 +1,4 @@
-#' Extracts the logged values of a function wrapped by a logging wrapper.
+#' Extracts the logged values of a function wrapped by a logging wrapper
 #'
 #' @param fn [\code{wrapped_smoof_function}]\cr
 #'   Wrapped smoof function.

R/getMeanFunction.R

@@ -1,4 +1,4 @@
-#' Returns the true mean function in the noisy case.
+#' Returns the true mean function in the noisy case
 #'
 #' @template arg_smoof_function
 #' @return [\code{function}]

R/getName.R

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

R/getNumberOfEvaluations.R

@@ -1,5 +1,5 @@
 #' Returns the number of function evaluations performed by the wrapped
-#' \code{smoof_function}.
+#' \code{smoof_function}
 #'
 #' @param fn [\code{smoof_counting_function}]\cr
 #'   Wrapped \code{smoof_function}.

R/getNumberOfObjectives.R

@@ -1,4 +1,4 @@
-#' Determines the number of objectives.
+#' Determines the number of objectives
 #'
 #' @template arg_smoof_function
 #' @return [\code{integer(1)}]

R/getNumberOfParameters.R

@@ -1,4 +1,4 @@
-#' Determines the number of parameters.
+#' Determines the number of parameters
 #'
 #' @template arg_smoof_function
 #' @return [\code{integer(1)}]

R/getParamSet.R

@@ -1,5 +1,5 @@
 #' @title
-#' Get parameter set.
+#' Get parameter set
 #'
 #' @description
 #' Each smoof function contains a parameter set of type \code{\link[ParamHelpers]{ParamSet}}

R/getRefPoint.R

@@ -1,4 +1,4 @@
-#' Returns the reference point of a multi-objective function.
+#' Returns the reference point of a multi-objective function
 #'
 #' @template arg_smoof_function
 #' @return [\code{numeric}]

R/getTags.R

@@ -1,4 +1,4 @@
-#' Returns the vector of associated tags.
+#' Returns the vector of associated tags
 #'
 #' @template arg_smoof_function
 #' @return [\code{character}]

R/getWrappedFunction.R

@@ -1,5 +1,5 @@
 #' @title
-#' Extract wrapped function.
+#' Extract wrapped function
 #'
 #' @description
 #' The \pkg{smoof} package offers means to let a function log its evaluations or

R/hasConstraints.R

@@ -1,4 +1,4 @@
-#' Checks whether the objective function has constraints.
+#' Checks whether the objective function has constraints
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}]
@@ -19,7 +19,7 @@ hasConstraints.smoof_wrapped_function = function(fn) {
   return(hasBoxConstraints(fn) || hasOtherConstraints(fn))
 }
 
-#' Checks whether the objective function has box constraints.
+#' Checks whether the objective function has box constraints
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}]
@@ -38,7 +38,7 @@ hasBoxConstraints.smoof_wrapped_function = function(fn) {
   return(ParamHelpers::hasFiniteBoxConstraints(getParamSet(getWrappedFunction(fn))))
 }
 
-#' Checks whether the objective function has other constraints.
+#' Checks whether the objective function has other constraints
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}]

R/hasGlobalOptimum.R

@@ -1,4 +1,4 @@
-#' Checks whether the global optimum is known.
+#' Checks whether the global optimum is known
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}]
@@ -23,7 +23,7 @@ hasGlobalOptimum.smoof_wrapped_function = function(fn) {
   return(hasGlobalOptimum(getWrappedFunction(fn)))
 }
 
-#' Checks whether local optima are known.
+#' Checks whether local optima are known
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}]

R/hasTags.R

@@ -1,5 +1,5 @@
 #' @title
-#' Checks if the function has assigned special tags.
+#' Checks if the function has assigned special tags
 #'
 #' @description
 #' Each single-objective smoof function has tags assigned to it (see

R/isMultiobjective.R

@@ -1,4 +1,4 @@
-#' Checks whether the given function is multi-objective.
+#' Checks whether the given function is multi-objective
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}] \code{TRUE} if function is multi-objective, \code{FALSE} otherwise.

R/isNoisy.R

@@ -1,4 +1,4 @@
-#' Checks whether the given function is noisy.
+#' Checks whether the given function is noisy
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}]

R/isSingleobjective.R

@@ -1,4 +1,4 @@
-#' Checks whether the given function is single-objective.
+#' Checks whether the given function is single-objective
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}] \code{TRUE} if function is single-objective, \code{FALSE} otherwise.

R/isSmoofFunction.R

@@ -1,5 +1,5 @@
 #' Checks whether the given object is a \code{smoof_function} or a
-#' \code{smoof_wrapped_function}.
+#' \code{smoof_wrapped_function}
 #'
 #' @param object [any]\cr
 #'   Arbitrary R object.

R/isVectorized.R

@@ -1,4 +1,4 @@
-#' Checks whether the given function accepts \dQuote{vectorized} input.
+#' Checks whether the given function accepts \dQuote{vectorized} input
 #'
 #' @template arg_smoof_function
 #' @return [\code{logical(1)}]

R/isWrappedSmoofFunction.R

@@ -1,4 +1,4 @@
-#' Checks whether the function is of type \code{smoof_wrapped_function}.
+#' Checks whether the function is of type \code{smoof_wrapped_function}
 #'
 #' @param object [any]\cr
 #'   Arbitrary R object.

R/makeBBOBFunction.R

@@ -1,5 +1,5 @@
 #' @title
-#' Generator for noiseless function set of the real-parameter BBOB.
+#' Generator for noiseless function set of the real-parameter BBOB
 #' 
 #' @description
 #' Generator for the noiseless function set of the real-parameter Black-Box

R/makeFunctionsByName.R

@@ -1,6 +1,6 @@
 #' @title
 #' Generate smoof function by passing a character vector of generator
-#' names.
+#' names
 #'
 #' @description
 #' This function is especially useful in combination with

R/makeMultiObjectiveFunction.R

@@ -1,4 +1,4 @@
-#' Generator for multi-objective target functions.
+#' Generator for multi-objective target functions
 #'
 #' @template arg_name
 #' @template arg_id

R/makeObjectiveFunction.R

@@ -1,4 +1,4 @@
-#' Internal generator for function of smoof type.
+#' Internal generator for function of smoof type
 #'
 #' @param name [\code{character(1)}]\cr
 #'   Optional function name used e.g. in plots.

R/makeSingleObjectiveFunction.R

@@ -1,4 +1,4 @@
-#' Generator for single-objective target functions.
+#' Generator for single-objective target functions
 #'
 #' @template arg_name
 #' @template arg_id

R/makeUFFunction.R

@@ -1,4 +1,4 @@
-#' Generator for the functions UF1, ..., UF10 of the CEC 2009.
+#' Generator for the functions UF1, ..., UF10 of the CEC 2009
 #'
 #' @template arg_dimensions
 #' @param id [\code{integer(1)}]\cr

R/mnof.R

@@ -1,5 +1,5 @@
 #' @title
-#' Helper function to create a numeric multi-objective optimization test function.
+#' Helper function to create a numeric multi-objective optimization test function
 #'
 #' @description
 #' This is a simplifying wrapper around \code{\link{makeMultiObjectiveFunction}}.

R/mof.MOP1.R

@@ -1,5 +1,5 @@
 #' @title
-#' MOP1 function generator.
+#' MOP1 function generator
 #'
 #' @description
 #' MOP1 function from Van Valedhuizen's test suite.

R/mof.MOP2.R

@@ -1,5 +1,5 @@
 #' @title
-#' MOP2 function generator.
+#' MOP2 function generator
 #'
 #' @description
 #' MOP2 function from Van Valedhuizen's test suite due to Fonseca and Fleming.

R/mof.MOP3.R

@@ -1,5 +1,5 @@
 #' @title
-#' MOP3 function generator.
+#' MOP3 function generator
 #'
 #' @description
 #' MOP3 function from Van Valedhuizen's test suite.

R/mof.MOP4.R

@@ -1,5 +1,5 @@
 #' @title
-#' MOP4 function generator.
+#' MOP4 function generator
 #'
 #' @description
 #' MOP4 function from Van Valedhuizen's test suite based on Kursawe.

R/mof.MOP5.R

@@ -1,5 +1,5 @@
 #' @title
-#' MOP5 function generator.
+#' MOP5 function generator
 #'
 #' @description
 #' MOP5 function from Van Valedhuizen's test suite.

R/mof.MOP6.R

@@ -1,5 +1,5 @@
 #' @title
-#' MOP6 function generator.
+#' MOP6 function generator
 #'
 #' @description
 #' MOP6 function from Van Valedhuizen's test suite.

R/mof.MOP7.R

@@ -1,5 +1,5 @@
 #' @title
-#' MOP7 function generator.
+#' MOP7 function generator
 #'
 #' @description
 #' MOP7 function from Van Valedhuizen's test suite.

R/mof.SYMPARTrotated.R

@@ -1,5 +1,6 @@
 #' @title
 #' SYM-PART Rotated Function
+#' @encoding UTF-8
 #'
 #' @description
 #' Test problem from the set of "multi-modal multi-objective functions" as for

R/mof.SYMPARTsimple.R

@@ -1,5 +1,6 @@
 #' @title
 #' SYM-PART Simple Function
+#' @encoding UTF-8
 #'
 #' @description
 #' Test problem from the set of "multi-modal multi-objective functions" as for

R/mof.gomop.R

@@ -1,5 +1,5 @@
 #' @title
-#' GOMOP function generator.
+#' GOMOP function generator
 #'
 #' @description
 #' Construct a multi-objective function by putting together multiple single-objective

R/mof.mmf1.R

@@ -1,5 +1,6 @@
 #' @title
 #' MMF1 Function
+#' @encoding UTF-8
 #'
 #' @description
 #' Test problem from the set of "multi-modal multi-objective functions" as for