add additional functions
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit

This commit is contained in:
Jared Knowles
2023-07-20 11:48:42 -04:00
parent 9acebb5133
commit ac63932a31
12 changed files with 446 additions and 0 deletions
+23
View File
@@ -0,0 +1,23 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{perturb_count}
\alias{perturb_count}
\title{Add a random jitter to a count variable to mask its true value}
\usage{
perturb_count(x, fac = 3)
}
\arguments{
\item{x}{the vector of numerics}
\item{fac}{the range of values to add or subtract to perturb the count}
}
\description{
Add a random jitter to a count variable to mask its true value
}
\details{
The count in the name means that this function enforces a floor of
0 on values, so values perturbed to have less than 0 will be capped at 0.
}
\examples{
perturb_count(20:30, fac = 3)
}