add additional functions
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit
This commit is contained in:
@@ -0,0 +1,24 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{z_univariate}
|
||||
\alias{z_univariate}
|
||||
\title{Calculate a univariate z score by comparing to a population}
|
||||
\usage{
|
||||
z_univariate(unit_prop, global_prop, unit_denom)
|
||||
}
|
||||
\arguments{
|
||||
\item{unit_prop}{proportion for the group we are comparing}
|
||||
|
||||
\item{global_prop}{the global proportion}
|
||||
|
||||
\item{unit_denom}{the population size for the group we are comparing}
|
||||
}
|
||||
\value{
|
||||
a z-score
|
||||
}
|
||||
\description{
|
||||
Calculate a univariate z score by comparing to a population
|
||||
}
|
||||
\examples{
|
||||
z_univariate(unit_prop = 0.13, global_prop = 0.11, unit_denom = 2500)
|
||||
}
|
||||
Reference in New Issue
Block a user