Add documentation for the poetest function

NAMESPACE

@@ -5,4 +5,5 @@ export(createSets)
 export(quicktexregapollo)
 export(remGOF)
 export(subcoef)
+export(takedraws)
 importFrom(magrittr,"%>%")

R/poetest.R

-
+# This function lets us perform the Poe (2005) test on WTP values
+
+
+#' Perform the Poe (2005) test on different discrete choice models
+#'
+#' @param n number of draws
+#' @param model1 Model from which to take the first WTP values
+#' @param model2 Model from which to take the second WTP values
+#' @param att Vector of attributes whose WTP values you want to compare
+#' @param price nmae of the price coefficient
+#' 
+#'
+#' @return a p value associated with "WTP1>WTP2"
+#' @export
+#'
+#' @examples {
+#' poeresults<-poetest(n=5000, model1 = clmodels[[model_1]],model2 = clmodels[[model_2]], att=attr, price = "bcost")
+#' }
 
 ## Extract relevant elements of models
 

man/takedraws.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/poetest.R
+\name{takedraws}
+\alias{takedraws}
+\title{Perform the Poe (2005) test on different discrete choice models}
+\usage{
+takedraws(n = 10000, beta, vc)
+}
+\arguments{
+\item{n}{number of draws}
+
+\item{model1}{Model from which to take the first WTP values}
+
+\item{model2}{Model from which to take the second WTP values}
+
+\item{att}{Vector of attributes whose WTP values you want to compare}
+
+\item{price}{nmae of the price coefficient}
+}
+\value{
+a p value associated with "WTP1>WTP2"
+}
+\description{
+Perform the Poe (2005) test on different discrete choice models
+}
+\examples{
+{
+poeresults<-poetest(n=5000, model1 = clmodels[[model_1]],model2 = clmodels[[model_2]], att=attr, price = "bcost")
+}
+}