minor documentation changes

s3alfisc · Sep 10, 2021 · 1cb4293 · 1cb4293
1 parent d00bc0e
commit 1cb4293
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: fwildclusterboot
 Title: Fast Wild Cluster Bootstrap Inference for Linear Regression Models
-Version: 0.3.6.1
-Date: 2021-08-27
+Version: 0.3.7
+Date: 2021-09-10
 Authors@R: 
     c(
     person(given = "Alexander",

diff --git a/R/boottest_felm.R b/R/boottest_felm.R
@@ -82,7 +82,7 @@ boottest.felm <- function(object,
   #' @return An object of class \code{boottest}
   #' 
   #' \item{p_val}{The bootstrap p-value.}
-  #' \item{t_stat}{The bootstrap t-statistic.}
+  #' \item{t_stat}{The regression t-statistic of interest, recalculated in the bootstrap.}
   #' \item{conf_int}{The bootstrap confidence interval.}
   #' \item{param}{The tested parameter.}
   #' \item{N}{Sample size. Might differ from the regression sample size if 

diff --git a/R/boottest_fixest.R b/R/boottest_fixest.R
@@ -80,7 +80,7 @@ boottest.fixest <- function(object,
   #' @return An object of class \code{boottest}
   #' 
   #' \item{p_val}{The bootstrap p-value.}
-  #' \item{t_stat}{The bootstrap t-statistic.}
+  #' \item{t_stat}{The regression t-statistic of interest, recalculated in the bootstrap.}
   #' \item{conf_int}{The bootstrap confidence interval.}
   #' \item{param}{The tested parameter.}
   #' \item{N}{Sample size. Might differ from the regression sample size if
@@ -167,6 +167,7 @@ boottest.fixest <- function(object,
   check_arg(tol, "numeric scalar")
   check_arg(maxiter, "scalar integer")
 
+
   # check appropriateness of nthreads
   nthreads <- check_set_nthreads(nthreads)
   #cat("nthreads boottest \n")

diff --git a/R/boottest_lm.R b/R/boottest_lm.R
@@ -79,7 +79,7 @@ boottest.lm <- function(object,
   #' @return An object of class \code{boottest}
   #' 
   #' \item{p_val}{The bootstrap p-value.}
-  #' \item{t_stat}{The bootstrap t-statistic.}
+  #' \item{t_stat}{The regression t-statistic of interest, recalculated in the bootstrap.}
   #' \item{conf_int}{The bootstrap confidence interval.}
   #' \item{param}{The tested parameter.}
   #' \item{N}{Sample size. Might differ from the regression sample size if the