documentation

R/tidy_beeca.R

@@ -13,8 +13,18 @@
 #' @param conf.level the confidence level to use for the confidence interval
 #'
 #' @return a tibble
+#'    The default values returned are the following
+#'    \tabular{ll}{
+#'        term      \tab treatment variable \cr
+#'        contrast  \tab the contrast used to estimate the marginal effect \cr
+#'        estimate  \tab the average treatment effect \cr
+#'        std.error \tab the standard error based on the Ge or Ye method \cr
+#'        statistic \tab the z-score of the estimate divided by the standard error \cr
+#'        p.value   \tab 2-sided p-value \cr
+#'        conf.low  \tab lower bound of the confidence interval (if specified) \cr
+#'        conf.high \tab upper bound of the confidence interval (if specified) \cr
+#'        }
 #' @export
-#'
 #' @examples
 #' # example use of tidy_beeca
 #' # Set treatment to a factor