From 158280380193c2f8a9e93ec4b4e00980fa56d7cd Mon Sep 17 00:00:00 2001 From: Joshua Lambert Date: Mon, 13 Nov 2023 13:48:38 +0000 Subject: [PATCH] added american spelling for is_parameterised and discretise functions --- NAMESPACE | 2 ++ R/checkers.R | 4 ++++ R/epidist.R | 4 ++++ man/discretise.Rd | 3 +++ man/is_parameterised.Rd | 3 +++ 5 files changed, 16 insertions(+) diff --git a/NAMESPACE b/NAMESPACE index 4bbe3b49f..c1313e9b7 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -36,6 +36,7 @@ export(create_epidist_region) export(create_epidist_summary_stats) export(create_epidist_uncertainty) export(discretise) +export(discretize) export(epidist) export(epidist_db) export(extract_param) @@ -44,6 +45,7 @@ export(get_parameters) export(is_epidist) export(is_epidist_params) export(is_parameterised) +export(is_parameterized) export(is_truncated) export(is_vb_epidist) export(list_distributions) diff --git a/R/checkers.R b/R/checkers.R index 01f83abc8..8663f53f7 100644 --- a/R/checkers.R +++ b/R/checkers.R @@ -34,6 +34,10 @@ is_parameterised <- function(x, ...) { UseMethod("is_parameterised") } +#' @rdname is_parameterised +#' @export +is_parameterized <- is_parameterised + #' @export is_parameterised.epidist <- function(x, ...) { chkDots(...) diff --git a/R/epidist.R b/R/epidist.R index bbb935a23..0a1b288af 100644 --- a/R/epidist.R +++ b/R/epidist.R @@ -762,6 +762,10 @@ discretise <- function(x, ...) { UseMethod("discretise") } +#' @rdname discretise +#' @export +discretize <- discretise + #' @rdname discretise #' @export discretise.epidist <- function(x, ...) { diff --git a/man/discretise.Rd b/man/discretise.Rd index 46c4216cf..55942dfe5 100644 --- a/man/discretise.Rd +++ b/man/discretise.Rd @@ -2,12 +2,15 @@ % Please edit documentation in R/epidist.R \name{discretise} \alias{discretise} +\alias{discretize} \alias{discretise.epidist} \alias{discretise.default} \title{Discretises a continuous distribution in an \verb{} object} \usage{ discretise(x, ...) +discretize(x, ...) + \method{discretise}{epidist}(x, ...) \method{discretise}{default}(x, ...) diff --git a/man/is_parameterised.Rd b/man/is_parameterised.Rd index 1451dc61f..e755bb58a 100644 --- a/man/is_parameterised.Rd +++ b/man/is_parameterised.Rd @@ -2,10 +2,13 @@ % Please edit documentation in R/checkers.R \name{is_parameterised} \alias{is_parameterised} +\alias{is_parameterized} \title{Check if \verb{} or list of \verb{} objects contains a distribution and distribution parameters} \usage{ is_parameterised(x, ...) + +is_parameterized(x, ...) } \arguments{ \item{x}{An \verb{} or list of \verb{} objects.}