fix doco

man/agresti_coull_interval.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/prop_conf.R
+\name{agresti_coull_interval}
+\alias{agresti_coull_interval}
+\title{Calculate the Agresti-Coull interval}
+\usage{
+agresti_coull_interval(num, den, conf.level)
+}
+\arguments{
+\item{num}{a number of successes}
+
+\item{den}{a number of trials}
+
+\item{conf.level}{default 0.95, set the confidence interval to return}
+}
+\value{
+an interval
+}
+\description{
+Calculate the Agresti-Coull interval
+}

man/civilytics-package.Rd

@@ -0,0 +1,11 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/civilytics-package.R
+\docType{package}
+\name{civilytics-package}
+\alias{civilytics}
+\alias{civilytics-package}
+\title{civilytics: Utilities Functions for Civilytics}
+\description{
+House R functions for Civilytics Consulting LLC This package implements a variety of useful functions for creating and branding analyses produced by Civilytics Consulting LLC.
+}
+\keyword{internal}

man/clopper_pearson.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/prop_conf.R
+\name{clopper_pearson}
+\alias{clopper_pearson}
+\title{Get a simple Clopper Pearson interval}
+\usage{
+clopper_pearson(num, den, conf.level = 0.95)
+}
+\arguments{
+\item{num}{number of successes}
+
+\item{den}{number of trials}
+
+\item{conf.level}{default 0.95, set the confidence interval to return}
+}
+\value{
+three values forming the upper and lower bounds of the confidence region and the true value
+}
+\description{
+Get a simple Clopper Pearson interval
+}

man/waldInterval.Rd

@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/prop_conf.R
+\name{waldInterval}
+\alias{waldInterval}
+\title{Calculate a Wald interval}
+\usage{
+waldInterval(x, n, conf.level = 0.95)
+}
+\arguments{
+\item{x}{the numerator, number of times the event occurs}
+
+\item{n}{the denominator, the number of trials}
+
+\item{conf.level}{default 0.95, set the confidence interval to return}
+}
+\value{
+two values forming the upper and lower bounds of the confidence region
+}
+\description{
+Calculate a Wald interval
+}
+\examples{
+waldInterval(x = 20, n =40) #this will return 0.345 and 0.655
+}

man/z_univariate.Rd

@@ -1,5 +1,5 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/utils.R
+% Please edit documentation in R/prop_conf.R
 \name{z_univariate}
 \alias{z_univariate}
 \title{Calculate a univariate z score by comparing to a population}