rerun doco

2022-10-16 17:53:59 -04:00
parent 20f65a7126
commit 38a7e2f242
6 changed files with 136 additions and 1 deletions
@@ -0,0 +1,26 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{star_subs}
+\alias{star_subs}
+\title{Unsuppress data using sampling}
+\usage{
+star_subs(x, replace_char = "*", zeros = 15, max_value = 20)
+}
+\arguments{
+\item{replace_char}{the character you want to replace in the vector}
+
+\item{zeros}{the number of zeroes to oversample when replacing replace_char}
+
+\item{max_value}{the numeric maximum value the replacement for the "*" can be}
+}
+\value{
+a numeric vector with no characters representing suppressed values
+}
+\description{
+Unsuppress data using sampling
+}
+\examples{
+suppr_data <- c("2", "8", "*", "*", "7", "9", "100")
+star_subs(suppr_data, zeros = 1, max_value = 10)
+star_subs(suppr_data, zeros = 1, max_value = 200)
+}