add df.t in doc

m-pilarski · Sep 13, 2023 · e78c6df · e78c6df
1 parent fe688ca
commit e78c6df
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 1 deletion.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -16,3 +16,4 @@
 ^_AUTO_BENCHMARK$
 ^CONTRIBUTORS\.md$
 ^.vscode
+^_DOCS$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -25,7 +25,6 @@ Description: Fast and user-friendly estimation of econometric models with multip
 License: GPL-3
 BugReports: https://github.com/lrberge/fixest/issues
 URL: https://lrberge.github.io/fixest/, https://github.com/lrberge/fixest
-SystemRequirements: C++11
 VignetteBuilder: knitr
 LazyData: true
 RoxygenNote: 7.2.3

diff --git a/NEWS.md b/NEWS.md
@@ -5,6 +5,8 @@
 
 - fix bug "t value" displaying in lieu of "z value". Thanks to issue on [easystats/parameters #892](https://github.com/easystats/parameters/issues/892). Very ancient bug!
 
+- fix bug in coefplot: now the confidence intervals use the Student t when appropriate (before that, only the Normal law was used). Thanks to Grant McDermott, [#409](https://github.com/lrberge/fixest/pull/408)
+
 # fixest 0.11.1
 
 ## Documentation bug

diff --git a/R/coefplot.R b/R/coefplot.R
@@ -62,6 +62,10 @@
 #' to [`graphics::abline`]. Example: `zero.par = list(col = "darkblue", lwd = 3)`.
 #' @param pt.join Logical, default is `FALSE`. If `TRUE`, then the coefficient estimates 
 #' are joined with a line.
+#' @param df.t Integer scalar or `NULL` (default). The degrees of freedom (DoF) to use
+#' when computing the confidence intervals with the Student t. By default it 
+#' tries to capture the DoF from the estimation. To use a Normal law to compute the 
+#' confidence interval, use `df.t = Inf`.
 #' @param pt.join.par List. Parameters of the line joining the coefficients. The 
 #' default values are: `col = pt.col` and `lwd = lwd`. You can add any graphical 
 #' parameter that will be passed to [`lines`]. Eg: `pt.join.par = list(lty = 2)`.

diff --git a/man/coefplot.Rd b/man/coefplot.Rd