fix doco

2024-08-09 15:34:39 -04:00
parent 82b8db7f84
commit f4a4ee85a7
9 changed files with 119 additions and 13 deletions
@@ -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
+}