From 5f96e8063e193c539fff5ba1aad15611c30f0d26 Mon Sep 17 00:00:00 2001 From: Bernd Bischl Date: Tue, 29 Jan 2019 22:41:39 +0100 Subject: [PATCH] SamplerHierarchical: fix typo in class name --- NAMESPACE | 2 +- R/SamplerHierachical.R | 6 +++--- R/SamplerUnif.R | 6 +++--- man/Sampler.Rd | 2 +- man/{SamplerHierachical.Rd => SamplerHierarchical.Rd} | 8 ++++---- man/SamplerJointIndep.Rd | 2 +- man/SamplerUnif.Rd | 6 +++--- 7 files changed, 16 insertions(+), 16 deletions(-) rename man/{SamplerHierachical.Rd => SamplerHierarchical.Rd} (87%) diff --git a/NAMESPACE b/NAMESPACE index 63a0c2da..f7c388f7 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -23,7 +23,7 @@ export(Sampler1DCateg) export(Sampler1DRfun) export(Sampler1DTruncNorm) export(Sampler1DUnif) -export(SamplerHierachical) +export(SamplerHierarchical) export(SamplerJointIndep) export(SamplerUnif) export(assert_param) diff --git a/R/SamplerHierachical.R b/R/SamplerHierachical.R index 78c4883d..f1824a07 100644 --- a/R/SamplerHierachical.R +++ b/R/SamplerHierachical.R @@ -1,4 +1,4 @@ -#' @title Sampler: Multivariate hierachical. +#' @title Sampler: Multivariate hierarchical. #' @format [R6Class] object. Inherits from [Sampler]. #' #' @description @@ -11,10 +11,10 @@ #' [ParamSet], list of [Sampler] -> `self` #' User has to pass one [Sampler1D] per param in set, which specifies its distribution. #' -#' @name SamplerHierachical +#' @name SamplerHierarchical #' @family Sampler #' @export -SamplerHierachical = R6Class("SamplerHierachical", inherit = Sampler, +SamplerHierarchical = R6Class("SamplerHierarchical", inherit = Sampler, public = list( samplers = NULL, diff --git a/R/SamplerUnif.R b/R/SamplerUnif.R index 1e79dee5..3270d733 100644 --- a/R/SamplerUnif.R +++ b/R/SamplerUnif.R @@ -1,9 +1,9 @@ #' @title Sampler: Multivariate uniform. -#' @format [R6Class] object. Inherits from [SamplerHierachical]. +#' @format [R6Class] object. Inherits from [SamplerHierarchical]. #' #' @description #' Uniform random sampling for arbitrary (bounded) param sets. -#' Constructs 1 uniform sampler per param, then passes them to [SamplerHierachical]. +#' Constructs 1 uniform sampler per param, then passes them to [SamplerHierarchical]. #' Hence, also works for param sets with dependencies. #' #' @section Public methods: @@ -13,7 +13,7 @@ #' @name SamplerUnif #' @family Sampler #' @export -SamplerUnif = R6Class("SamplerUnif", inherit = SamplerHierachical, +SamplerUnif = R6Class("SamplerUnif", inherit = SamplerHierarchical, public = list( initialize = function(param_set) { assert_paramset(param_set, must_bounded = TRUE, no_deps = FALSE, no_untyped = TRUE) diff --git a/man/Sampler.Rd b/man/Sampler.Rd index f2017b76..fd24b1f1 100644 --- a/man/Sampler.Rd +++ b/man/Sampler.Rd @@ -42,7 +42,7 @@ Inheriting sublcasses have to implement thus, called from \code{sample()} } \seealso{ -Other Sampler: \code{\link{SamplerHierachical}}, +Other Sampler: \code{\link{SamplerHierarchical}}, \code{\link{SamplerJointIndep}}, \code{\link{SamplerUnif}} } diff --git a/man/SamplerHierachical.Rd b/man/SamplerHierarchical.Rd similarity index 87% rename from man/SamplerHierachical.Rd rename to man/SamplerHierarchical.Rd index fb8249d6..f99ed0d3 100644 --- a/man/SamplerHierachical.Rd +++ b/man/SamplerHierarchical.Rd @@ -1,12 +1,12 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/SamplerHierachical.R \docType{data} -\name{SamplerHierachical} -\alias{SamplerHierachical} -\title{Sampler: Multivariate hierachical.} +\name{SamplerHierarchical} +\alias{SamplerHierarchical} +\title{Sampler: Multivariate hierarchical.} \format{\link{R6Class} object. Inherits from \link{Sampler}.} \usage{ -SamplerHierachical +SamplerHierarchical } \description{ Hierarchical sampling for arbitrary param sets with dependencies, where the user specifies 1D samplers per param. diff --git a/man/SamplerJointIndep.Rd b/man/SamplerJointIndep.Rd index 46dd5288..908ade12 100644 --- a/man/SamplerJointIndep.Rd +++ b/man/SamplerJointIndep.Rd @@ -28,7 +28,7 @@ list of \link{Sampler} -> \code{self} } \seealso{ -Other Sampler: \code{\link{SamplerHierachical}}, +Other Sampler: \code{\link{SamplerHierarchical}}, \code{\link{SamplerUnif}}, \code{\link{Sampler}} } \concept{Sampler} diff --git a/man/SamplerUnif.Rd b/man/SamplerUnif.Rd index 6436ea6b..04ec3d77 100644 --- a/man/SamplerUnif.Rd +++ b/man/SamplerUnif.Rd @@ -4,13 +4,13 @@ \name{SamplerUnif} \alias{SamplerUnif} \title{Sampler: Multivariate uniform.} -\format{\link{R6Class} object. Inherits from \link{SamplerHierachical}.} +\format{\link{R6Class} object. Inherits from \link{SamplerHierarchical}.} \usage{ SamplerUnif } \description{ Uniform random sampling for arbitrary (bounded) param sets. -Constructs 1 uniform sampler per param, then passes them to \link{SamplerHierachical}. +Constructs 1 uniform sampler per param, then passes them to \link{SamplerHierarchical}. Hence, also works for param sets with dependencies. } \section{Public methods}{ @@ -22,7 +22,7 @@ Hence, also works for param sets with dependencies. } \seealso{ -Other Sampler: \code{\link{SamplerHierachical}}, +Other Sampler: \code{\link{SamplerHierarchical}}, \code{\link{SamplerJointIndep}}, \code{\link{Sampler}} } \concept{Sampler}