etable: Estimations table (export the results of multiples...
In fixest: Fast Fixed-Effects Estimations
esttable R Documentation
Estimations table (export the results of multiples estimations to a DF or to Latex)
Description
Aggregates the results of multiple estimations and displays them in the form of either a Latex
table or a data.frame. Note that you will need the booktabs package for the Latex table to
render properly. See setFixest_etable to set the default values, and style.tex to customize Latex output.
Usage
esttable(
...,
vcov = NULL,
stage = 2,
agg = NULL,
se = NULL,
ssc = NULL,
cluster = NULL,
.vcov_args = NULL,
digits = 4,
digits.stats = 5,
fitstat = NULL,
coefstat = "se",
ci = 0.95,
se.row = NULL,
se.below = NULL,
keep = NULL,
drop = NULL,
order = NULL,
keep_raw = NULL,
drop_raw = NULL,
order_raw = NULL,
dict = TRUE,
coef.sub = NULL,
file = NULL,
replace = TRUE,
create_dirs = FALSE,
convergence = NULL,
signif.code = NULL,
headers = list("auto"),
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
keepFactors = TRUE,
family = NULL,
powerBelow = -5,
interaction.combine = NULL,
interaction.order = NULL,
i.equal = NULL,
depvar = TRUE,
style.df = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
drop.section = NULL,
poly_dict = c("", " square", " cube"),
postprocess.df = NULL,
fit_format = "__var__",
coef.just = NULL,
highlight = NULL,
coef.style = NULL,
export = NULL,
page.width = "fit",
div.class = "etable"
)
esttex(
...,
vcov = NULL,
stage = 2,
agg = NULL,
se = NULL,
ssc = NULL,
cluster = NULL,
.vcov_args = NULL,
digits = 4,
digits.stats = 5,
fitstat = NULL,
caption = NULL,
coefstat = "se",
ci = 0.95,
se.row = NULL,
se.below = NULL,
keep = NULL,
drop = NULL,
order = NULL,
keep_raw = NULL,
drop_raw = NULL,
order_raw = NULL,
dict = TRUE,
coef.sub = NULL,
file = NULL,
replace = TRUE,
create_dirs = FALSE,
convergence = NULL,
signif.code = NULL,
label = NULL,
float = NULL,
headers = list("auto"),
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
keepFactors = TRUE,
family = NULL,
powerBelow = -5,
interaction.combine = NULL,
interaction.order = NULL,
i.equal = NULL,
depvar = TRUE,
style.tex = NULL,
notes = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
placement = "htbp",
drop.section = NULL,
poly_dict = c("", " square", " cube"),
postprocess.tex = NULL,
tpt = FALSE,
arraystretch = NULL,
adjustbox = NULL,
fontsize = NULL,
fit_format = "__var__",
tabular = "normal",
highlight = NULL,
coef.style = NULL,
meta = NULL,
meta.time = NULL,
meta.author = NULL,
meta.sys = NULL,
meta.call = NULL,
meta.comment = NULL,
view = FALSE,
export = NULL,
markdown = NULL,
page.width = "fit",
div.class = "etable"
)
etable(
...,
vcov = NULL,
stage = 2,
agg = NULL,
se = NULL,
ssc = NULL,
cluster = NULL,
.vcov_args = NULL,
digits = 4,
digits.stats = 5,
tex,
fitstat = NULL,
caption = NULL,
coefstat = "se",
ci = 0.95,
se.row = NULL,
se.below = NULL,
keep = NULL,
drop = NULL,
order = NULL,
keep_raw = NULL,
drop_raw = NULL,
order_raw = NULL,
dict = TRUE,
coef.sub = NULL,
file = NULL,
replace = TRUE,
create_dirs = FALSE,
convergence = NULL,
signif.code = NULL,
label = NULL,
float = NULL,
headers = list("auto"),
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
keepFactors = TRUE,
family = NULL,
powerBelow = -5,
interaction.combine = NULL,
interaction.order = NULL,
i.equal = NULL,
depvar = TRUE,
style.tex = NULL,
style.df = NULL,
notes = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
placement = "htbp",
drop.section = NULL,
poly_dict = c("", " square", " cube"),
postprocess.tex = NULL,
postprocess.df = NULL,
tpt = FALSE,
arraystretch = NULL,
adjustbox = NULL,
fontsize = NULL,
fit_format = "__var__",
coef.just = NULL,
tabular = "normal",
highlight = NULL,
coef.style = NULL,
meta = NULL,
meta.time = NULL,
meta.author = NULL,
meta.sys = NULL,
meta.call = NULL,
meta.comment = NULL,
view = FALSE,
export = NULL,
markdown = NULL,
page.width = "fit",
div.class = "etable"
)
setFixest_etable(
digits = 4,
digits.stats = 5,
fitstat,
coefstat = c("se", "tstat", "confint", "pvalue"),
ci = 0.95,
se.below = TRUE,
keep,
drop,
order,
dict,
float,
signif.code = NULL,
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
family,
powerBelow = -5,
interaction.order = NULL,
depvar,
style.tex = NULL,
style.df = NULL,
notes = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
placement = "htbp",
drop.section = NULL,
view = FALSE,
markdown = NULL,
view.cache = TRUE,
page.width = "fit",
div.class = "etable",
postprocess.tex = NULL,
postprocess.df = NULL,
fit_format = "__var__",
meta.time = NULL,
meta.author = NULL,
meta.sys = NULL,
meta.call = NULL,
meta.comment = NULL,
reset = FALSE,
save = FALSE
)
getFixest_etable()
## S3 method for class 'etable_tex'
print(x, ...)
## S3 method for class 'etable_df'
print(x, ...)
log_etable(type = "pdflatex")
Arguments
...
Used to capture different fixest estimation objects (obtained with femlm,
feols or feglm). Note that any other type of element is discarded. Note that you can
give a list of fixest objects.
vcov
Versatile argument to specify the VCOV.
In general, it is either a character scalar equal to a VCOV type, either a formula of the form:
vcov_type ~ variables. The VCOV types implemented are: "iid", "hetero" (or "HC1"),
"cluster", "twoway", "NW" (or "newey_west"), "DK" (or "driscoll_kraay"), and "conley".
It also accepts object from vcov_cluster, vcov_NW, NW, vcov_DK, DK, vcov_conley and conley.
It also accepts covariance matrices computed externally.
Finally it accepts functions to compute the covariances.
See the vcov documentation in the vignette.
You can pass several VCOVs (as above) if you nest them into a list.
If the number of VCOVs equals the number of models, eahc VCOV is mapped to the appropriate model.
If there is one model and several VCOVs, or if the first element of the list is equal to
"each" or "times", then the estimations will be replicated and the results
for each estimation and each VCOV will be reported.
stage
Can be equal to 2 (default), 1, 1:2 or 2:1. Only used if the object
is an IV estimation: defines the stage to which summary should be applied. If stage = 1
and there are multiple endogenous regressors or if stage is of length 2, then an
object of class fixest_multi is returned.
agg
A character scalar describing the variable names to be aggregated,
it is pattern-based. For sunab estimations, the following keywords work: "att",
"period", "cohort" and FALSE (to have full disaggregation). All variables that
match the pattern will be aggregated. It must be of the form "(root)", the parentheses
must be there and the resulting variable name will be "root". You can add another
root with parentheses: "(root1)regex(root2)", in which case the resulting
name is "root1::root2". To name the resulting variable differently you can pass
a named vector: c("name" = "pattern") or c("name" = "pattern(root2)"). It's a
bit intricate sorry, please see the examples.
se
Character scalar. Which kind of standard error should be computed:
“standard”, “hetero”, “cluster”, “twoway”, “threeway”
or “fourway”? By default if there are clusters in the estimation:
se = "cluster", otherwise se = "iid". Note that this argument is deprecated,
you should use vcov instead.
ssc
An object of class ssc_type obtained with the function ssc. Represents
how the small sample correction should be done. You must use the function ssc
for this argument. The arguments and defaults of the function ssc are:
K.adj = TRUE, K.fixef = "nonnested", G.adj = TRUE, G.df = "min",
t.df = "min", K.exact = FALSE). See the help of the function ssc for details.
Not all VCOV types are affected by this argument.
cluster
Tells how to cluster the standard-errors (if clustering is requested).
Can be either a list of vectors, a character vector of variable names, a formula or
an integer vector. Assume we want to perform 2-way clustering over var1 and var2
contained in the data.frame base used for the estimation. All the following
cluster arguments are valid and do the same thing:
cluster = base[, c("var1", "var2")], cluster = c("var1", "var2"), cluster = ~var1+var2.
If the two variables were used as fixed-effects in the estimation, you can leave it
blank with vcov = "twoway" (assuming var1 [resp. var2] was
the 1st [resp. 2nd] fixed-effect). You can interact two variables using ^ with
the following syntax: cluster = ~var1^var2 or cluster = "var1^var2".
.vcov_args
A list containing arguments to be passed to the function vcov.
digits
Integer or character scalar. Default is 4 and represents the number of significant
digits to be displayed for the coefficients and standard-errors. To apply rounding instead of
significance use, e.g., digits = "r3" which will round at the first 3 decimals. If character,
it must be of the form "rd" or "sd" with d a digit (r is for round and s is for
significance). For the number of digits for the fit statistics, use digits.stats. Note that
when significance is used it does not exactly display the number of significant digits: see
details for its exact meaning.
digits.stats
Integer or character scalar. Default is 5 and represents the number of
significant digits to be displayed for the fit statistics. To apply rounding instead of
significance use, e.g., digits = "r3" which will round at the first 3 decimals. If character,
it must be of the form "rd" or "sd" with d a digit (r is for round and s is for
significance). Note that when significance is used it does not exactly display the number of
significant digits: see details for its exact meaning.
fitstat
A character vector or a one sided formula (both with only lowercase letters). A
vector listing which fit statistics to display. The valid types are 'n', 'll', 'aic', 'bic' and
r2 types like 'r2', 'pr2', 'war2', etc (see all valid types in r2). Also accepts valid types
from the function fitstat. The default value depends on the models to display. Example of
use: fitstat=c('n', 'cor2', 'ar2', 'war2'), or fitstat=~n+cor2+ar2+war2 using a formula. You
can use the dot to refer to default values: ~ . + ll would add the log-likelihood to the
default fit statistics.
coefstat
One of "se" (default), "tstat", "pvalue", or "confint". The statistic to report for
each coefficient: the standard-error, the t-statistics, the p-value,
or the confidence interval. You can adjust the confidence interval with the argument ci.
ci
Level of the confidence interval, defaults to 0.95. Only used if
coefstat = confint.
se.row
Logical scalar, default is NULL. Whether should be displayed the row with the
type of standard-error for each model. When tex = FALSE, the default is TRUE.
When tex = FALSE, the row is showed only when there is a table-footer and the types of
standard-errors differ across models.
se.below
Logical or NULL (default). Should the standard-errors be displayed below the
coefficients? If NULL, then this is TRUE for Latex and FALSE otherwise.
keep
Character vector. This element is used to display only a subset of variables. This
should be a vector of regular expressions (see base::regex help for more info). Each
variable satisfying any of the regular expressions will be kept. This argument is applied post
aliasing (see argument dict).
Use the argument keep_raw for the same effect before aliasing.
Example: you have the variable x1 to x55 and want to display
only x1 to x9, then you could use keep = "x[[:digit:]]$". If the first character is an
exclamation mark, the effect is reversed (e.g. keep = "!Constant" means: every variable that
does not contain “Constant” is kept). See details.
drop
Character vector. This element is used if some variables are not to be displayed.
This should be a vector of regular expressions (see base::regex help for more info). Each
variable satisfying any of the regular expressions will be discarded. This argument is applied
post aliasing (see argument dict).
Use the argument drop_raw for the same effect before aliasing.
Example: you have the variable x1 to x55 and want to
display only x1 to x9, then you could use drop = "x[[:digit:]]{2}". If the first character
is an exclamation mark, the effect is reversed (e.g. drop = "!Constant" means: every variable
that does not contain “Constant” is dropped). See details.
order
Character vector. This element is used if the user wants the variables to be
ordered in a certain way. This should be a vector of regular expressions (see base::regex
help for more info). The variables satisfying the first regular expression will be placed first,
then the order follows the sequence of regular expressions. This argument is applied post
aliasing (see argument dict). Use the argument order_raw for the same effect before aliasing.
Example: you have the following variables: month1 to month6,
then x1 to x5, then year1 to year6. If you want to display first the x's, then the
years, then the months you could use: order = c("x", "year"). If the first character is an
exclamation mark, the effect is reversed (e.g. order = "!Constant" means: every variable that
does not contain “Constant” goes first). See details.
keep_raw
Character vector. This element is used to display only a subset of variables.
This should be a vector of regular expressions (see base::regex help for more info). Each
variable satisfying any of the regular expressions will be kept. This argument is applied before
aliasing (see argument dict).
Use the argument keep for the same effect after aliasing.
Example: you have the variable x1 to x55 and want to display
only x1 to x9, then you could use keep = "x[[:digit:]]$". If the first character is an
exclamation mark, the effect is reversed (e.g. keep_raw = "!Intercept" means:
every variable that does not contain “Intercept” is kept). See details.
drop_raw
Character vector. This element is used if some variables are not to
be displayed.
This should be a vector of regular expressions (see base::regex help for more info). Each
variable satisfying any of the regular expressions will be discarded. This argument is applied
before aliasing (see argument dict).
Use the argument drop for the same effect after aliasing.
Example: you have the variable x1 to x55 and want to
display only x1 to x9, then you could use drop = "x[[:digit:]]{2}". If the first character
is an exclamation mark, the effect is reversed (e.g. drop_raw = "!Intercept" means:
every variable that does not contain “Intercept” is dropped). See details.
order_raw
Character vector. This element is used if the user wants the variables to be
ordered in a certain way. This should be a vector of regular expressions (see base::regex
help for more info). The variables satisfying the first regular expression will be placed first,
then the order follows the sequence of regular expressions. This argument is applied post
aliasing (see argument dict).
Use the argument order for the same effect after aliasing.
Example: you have the following variables: month1 to month6,
then x1 to x5, then year1 to year6. If you want to display first the x's, then the
years, then the months you could use: order = c("x", "year"). If the first character is an
exclamation mark, the effect is reversed (e.g. order = "!Intercept" means: every variable that
does not contain “Intercept” goes first). See details.
dict
A named character vector or a logical scalar. It changes the original variable names
to the ones contained in the dictionary. E.g. to change the variables named a and b3 to
(resp.) “$log(a)$” and to “$bonus^3$”, use dict=c(a="$log(a)$",b3="$bonus^3$").
By default, it is equal to getFixest_dict(), a default dictionary which can be set with
setFixest_dict. You can use dict = FALSE to disable it. By default dict modifies the
entries in the global dictionary, to disable this behavior, use "reset" as the first element
(ex: dict=c("reset", mpg="Miles per gallon")).
coef.sub
A character vector, default is NULL. Modifications to be applied to the
final coefficient names (after the dictionary is applied). It only affect the coefficients
and not the fixed-effects (use dict for that).
Each element of this vector
should be of the form "pat => new" or "pat". If "pat => new", this means that the
regular expression pattern "pat" will be replaced with "new". If "pat", this means that the
regex pattern "pat" will be removed. You can apply
stringmagic flags at
the beginning of the patterns, e.g. "i/pat" ignores the case.
This internal function applying the changes is string_clean.
Ex: say you have two coefficients named "genderF" and "oldTRUE". Then using
coef.sub=c("gender => Gender = ", "TRUE") renames the coefficients into
"Gender = F" and "old".
file
A character scalar. If provided, the Latex (or data frame) table will be saved in a
file whose path is file. If you provide this argument, then a Latex table will be exported, to
export a regular data.frame, use argument tex = FALSE.
replace
Logical, default is FALSE. Only used if option file is used. Should the
exported table be written in a new file that replaces any existing file?
create_dirs
Logical, default is FALSE. Only used if when some file needs to be
created (e;g. when file or export is used). By default, i.e. when FALSE,
if the parent directory does not exist, the containing folders are created
up to the grand parent.
If TRUE, all containing folders are recursively created.
convergence
Logical, default is missing. Should the convergence state of the algorithm be
displayed? By default, convergence information is displayed if at least one model did not
converge.
signif.code
Named numeric vector, used to provide the significance codes with respect to
the p-value of the coefficients. Default is c("***"=0.01, "**"=0.05, "*"=0.10) for a Latex
table and c("***"=0.001, "**"=0.01, "*"=0.05, "."=0.10) for a data.frame (to conform with R's
default). To suppress the significance codes, use signif.code=NA or signif.code=NULL. Can
also be equal to "letters", then the default becomes c("a"=0.01, "b"=0.05, "c"=0.10).
headers
Character vector or list. Adds one or more header lines in the table. A header
line can be represented by a character vector or a named list.
This argument can be many things, please have a look at the dedicated help section;
a simplified description follows.
If a named list, each element of the list represents a line, the names of the list are
the row names and the values are the content of the cells.
A line can be represented by: i) a character vector, ii) a list of the form
list("value1" = nb1, "value2" = nb2, etc). In the list form, numeric numbers
represent spans and integers represent absolute positions.
Example: headers=lits(Gender = list("M"=2, "F"=3)) will create a
row with 2 times "M" and three time "F" (this is identical to
headers=list(Gender = c("M", "M", "F", "F", "F"))).
You can stack header lines within a list, in that case the
list names will be displayed in the leftmost cell.
Example: headers=list(Gender=list("M"=2, "F"=3), Country="US") will create two header lines.
When tex = TRUE, you can add a rule to separate groups by using ":_:" somewhere in the row
name (ex: headers=list(":_:Gender"=list("M"=2, "F"=3)). You can monitor the placement by
inserting a special character in the row name: "^" means at the top, "-" means in the middle
(default) and "_" means at the bottom. Example: headers=list("_Country"="US") will add the
country row as the very last header row (after the model row). Finally, you can use the special
value "auto" to include automatic headers when the data contains split sample estimations. By
default it is equal to list("auto"). You can use .() instead of list().
fixef_sizes
(Tex only.) Logical, default is FALSE. If TRUE and fixed-effects were
used in the models, then the number of "units" per fixed-effect dimension is also displayed.
fixef_sizes.simplify
Logical, default is TRUE. Only used if fixef_sizes = TRUE. If
TRUE, the fixed-effects sizes will be displayed in parentheses instead of in a separate line
if there is no ambiguity (i.e. if the size is constant across models).
keepFactors
Logical, default is TRUE. If FALSE, then factor variables are displayed
as fixed-effects and no coefficient is shown.
family
Logical, default is missing. Whether to display the families of the models. By
default this line is displayed when at least two models are from different families.
powerBelow
(Tex only.) Integer, default is -5. A coefficient whose value is below
10**(powerBelow+1) is written with a power in Latex. For example 0.0000456 would be written
4.56$\\times 10^{-5}$ by default. Setting powerBelow = -6 would lead to 0.00004 in Latex.
interaction.combine
Character scalar, defaults to " $\\times$ " for Tex and to " x "
otherwise. When the estimation contains interactions, then the variables names (after aliasing)
are combined with this argument. For example: if dict = c(x1="Wind", x2="Rain") and you have
the following interaction x1:x2, then it will be renamed (by default)
Wind $\\times$ Rain – using interaction.combine = "*" would lead to Wind*Rain.
interaction.order
Character vector of regular expressions. Only affects variables that
are interacted like x1 and x2 in feols(y ~ x1*x2, data). You can change the order in which the
interacted variables are displayed: e.g. interaction.order = "x2" would lead to "x2 x x1"
instead of "x1 x x2". Please look at the argument 'order' and the dedicated section in the help
page for more information.
i.equal
Character scalar, defaults to " $=$ " when tex = TRUE and " = " otherwise.
Only affects factor variables created with the function i, tells how the variable should be
linked to its value. For example if you have the Species factor from the iris data set, by
default the display of the variable is Species = Setosa, etc. If i.equal = ": " the display
becomes Species: Setosa.
depvar
Logical, default is TRUE. Whether a first line containing the dependent
variables should be shown.
style.df
An object created by the function style.df It represents the style of the
data frame returned (if tex = FALSE), see the documentation of style.df.
group
A list. The list elements should be vectors of regular expressions. For each
elements of this list: A new line in the table is created, all variables that are matched by the
regular expressions are discarded (same effect as the argument drop) and TRUE or FALSE
will appear in the model cell, depending on whether some of the previous variables were found in
the model.
Example: group=list("Controls: personal traits"=c("gender", "height", "weight"))
will create an new line with "Controls: personal traits" in the leftmost cell, all three
variables gender, height and weight are discarded, TRUE appearing in each model containing at
least one of the three variables (the style of TRUE/FALSE is governed by the argument
yesNo). You can control the placement of the new row by using 1 or 2 special characters at the
start of the row name.
The meaning of these special characters are: 1) "^": coef., "-": fixed-effect,
"_": stats, section; 2) "^": 1st, "_": last, row.
For example: group=list("_^Controls"=stuff) will place the line at the top of the 'stats'
section, and using group=list("^_Controls"=stuff) will make the row appear at the bottom of
the coefficients section. For details, see the dedicated section.
extralines
A vector, a list or a one sided formula. The list elements should be either a
vector representing the value of each cell, a list of the form
list("item1" = nb1, "item2" = nb2, etc), or a function.
This argument can be many things, please have a look at the dedicated help section;
a simplified description follows. For each elements of this list: A new line in the table is
created, the list name being the row name and the vector being the content of the cells.
Example: extralines=list("Sub-sample"=c("<20 yo", "all", ">50 yo")) will create an new line
with "Sub-sample" in the leftmost cell, the vector filling the content of the cells for the
three models. You can control the placement of the new row by using 1 or 2 special characters at
the start of the row name. The meaning of these special characters are:
-
"^": coef., "-": fixed-effect, "_": stats, section;
-
"^": 1st, "_": last, row.
For example: extralines=list("__Controls"=stuff) will place the line at the bottom of the
stats section, and using extralines=list("^^Controls"=stuff) will make the row appear at the
top of the 'coefficients' section. For details, see the dedicated section. You can use .()
instead of list().
fixef.group
Logical scalar or list (default is NULL). If equal to TRUE, then all
fixed-effects always appearing jointly in models will be grouped in one row. If a list, its
elements must be character vectors of regular expressions and the list names will be the row
names. For ex. fixef.group=list("Dates fixed-effects"="Month|Day") will remove the "Month"
and "Day" fixed effects from the display and replace them with a single row named
"Dates fixed-effects". You can monitor the placement of the new row with two special characters
telling where to place the row within a section: first in which section it should appear:
"^" (coef.), "-" (fixed-effects), or "_" (stat.) section;
then whether the row should be "^" (first), or "_" (last). These two special characters must
appear first in the row names. Please see the dedicated section
drop.section
Character vector which can be of length 0 (i.e. equal to NULL). Can
contain the values "coef", "fixef", "slopes" or "stats". It would drop, respectively, the
coefficients section, fixed-effects section, the variables with varying slopes section or the
fit statistics section.
poly_dict
Character vector, default is c("", " square", " cube"). When raw polynomials
(x^2, etc) are used, the variables are automatically renamed and poly_dict rules the display
of the power. For powers greater than the number of elements of the vector, the value displayed
is $^{pow}$ in Latex and ^ pow in the R console.
postprocess.df
A function that will postprocess.tex the resulting data.frame. Only when
tex = FALSE. By default it is equal to NULL, meaning that there is no postprocessing. When
tex = TRUE, see the argument postprocess.tex.
fit_format
Character scalar, default is "__var__". Only used in the presence of IVs. By
default the endogenous regressors are named fit_varname in the second stage. The format of the
endogenous regressor to appear in the table is governed by fit_format. For instance, by
default, the prefix "fit_" is removed, leading to only varname to appear.
If fit_format = "$\\\\hat{__var__$"}, then "$\\hat{varname$"} will appear in the table.
coef.just
(DF only.) Either ".", "(", "l", "c" or "r", default is NULL.
How the coefficients should be justified. If NULL then they are right aligned if
se.below = FALSE and aligned to the dot if se.below = TRUE. The keywords stand
respectively for dot-, parenthesis-, left-, center- and right-aligned.
highlight
List containing coefficients to highlight.
Highlighting is of the form .("options1" = "coefs1", "options2" = "coefs2", etc).
The coefficients to be highlighted can be written in three forms: 1) row, eg "x1" will
highlight the full row of the variable x1;
2) cells, use '@' after the coefficient name to
give the column, it accepts ranges, eg "x1@2, 4-6, 8" will highlight only the columns
2, 4, 5, 6, and 8 of the variable x1; 3) range, by giving the top-left and
bottom-right values separated with a semi-colon, eg "x1@2 ; x3@5" will highlight
from the column 2 of x1 to the 5th column of x3. Coefficient names are partially
matched, use a '%' first to refer to the original name (before dictionary) and
use '@' first to use a regular expression. You can add a vector of row/cell/range.
The options are a comma-separated list of items. By default the highlighting is done
with a frame (a thick box) around the coefficient, use 'rowcol' to highlight with a
row color instead. Here are the other options: 'se' to highlight the standard-errors too;
'square' to have a square box (instead of rounded); 'thick1' to 'thick6'
to monitor the width of the box; 'sep0' to 'sep9' to monitor the inner spacing.
Finally the remaining option is the color: simply add an R color (it must be a valid R color!).
You can use "color!alpha" with "alpha" a number between 0 to 100 to change
the alpha channel of the color.
To be able to use use the highlighting feature, you need the
following lines in your latex preamble: \\usepackage{tikz} and
\\usetikzlibrary{matrix, shapes, arrows, fit, tikzmark}
coef.style
Named list containing styles to be applied to the coefficients. It must be of
the form .("style1" = "coefs1", "style2" = "coefs2", etc). The style must contain the
string ":coef:" (or ":coef_se:" to style both the coefficient and its standard-error).
The string :coef: will be replaced verbatim by the coefficient value. For example use
"\\textbf{:coef:}" to put the coefficient in bold. Note that markdown markup is enabled
so "**:coef:**" would also put it in bold. The coefficients to be styled can be written
in three forms: 1) row, eg "x1" will style the full row of the variable x1; 2) cells,
use '@' after the coefficient name to give the column, it accepts ranges,
eg "x1@2, 4-6, 8" will style only the columns 2, 4, 5, 6, and 8 of the variable x1;
3) range, by giving the top-left and bottom-right values separated with a semi-colon,
eg "x1@2 ; x3@5" will style from the column 2 of x1 to the 5th column of x3.
Coefficient names are partially matched, use a '%' first to refer to the original name
(before dictionary) and use '@' first to use a regular expression. You can add a
vector of row/cell/range.
export
Character scalar giving the path to a PNG file to be created, default is NULL.
If provided, the Latex table will be converted to PNG and copied to the export location. Note
that for this option to work you need a working distribution of pdflatex, imagemagick and
ghostscript, or the R packages tinytex and pdftools.
page.width
Character scalar equal to 'fit' (default), 'a4' or 'us'; or a
single Latex measure (like '17cm') or a double one (like "21, 2cm"). Only used when
the Latex table is to be viewed (view = TRUE), exported (export != NULL) or displayed
in Rmarkdown (markdown != NULL). It represents the text width of the page in which the
Latex table will be inserted. By default, 'fit', the page fits exactly the table (i.e.
text width = table width). If 'a4' or 'us', two times 2cm is removed from the page
width to account for margins. Providing a page width and a margin width, like in
"17in, 1in", enables a correct display of the argument adjustbox. Note that the
margin width represent the width of a single side margin (and hence will be doubled).
div.class
Character scalar, default is "etable". Only used in Rmarkdown documents
when markdown = TRUE. The table in an image format is embedded in a <div> container,
and that container is of class div.class.
caption
(Tex only.) Character scalar. The caption of the Latex table.
label
(Tex only.) Character scalar. The label of the Latex table.
float
(Tex only.) Logical. By default, if the argument caption or label is provided,
it is set to TRUE. Otherwise, it is set to FALSE.
style.tex
An object created by the function style.tex. It represents the style of the
Latex table, see the documentation of style.tex.
notes
(Tex only.) Character vector. If provided, a "notes" section will be added at the
end right after the end of the table, containing the text of this argument. If it is a vector,
it will be collapsed with new lines. If tpt = TRUE, the behavior is different: each element of
the vector is an item. If the first element of the vector starts with "@", then it will be
included verbatim, and in case of tpt = TRUE, right before the first item. If that element is
provided, it will replace the value defined in style.tex(notes.intro) or
style.tex(notes.tpt.intro).
placement
(Tex only.) Character string giving the position of the float in Latex. Default
is "htbp". It must consist of only the characters 'h', 't', 'b', 'p', 'H' and '!'.
Reminder: h: here; t: top; b: bottom; p: float page; H: definitely here;
!: prevents Latex to look for other positions. Note that it can be equal to the empty string
(and you'll get the default placement).
postprocess.tex
A function that will postprocess the character vector defining the latex
table. Only when tex = TRUE. By default it is equal to NULL, meaning that there is no
postprocessing. When tex = FALSE, see the argument postprocess.df. See details.
tpt
(Tex only.) Logical scalar, default is FALSE. Whether to use the threeparttable
environment. If so, the notes will be integrated into the tablenotes environment.
arraystretch
(Tex only.) A numeric scalar, default is NULL. If provided,
the command \\renewcommand*{\\arraystretch{x}} is inserted, replacing x by the value of
arraystretch. The changes are specific to the current table and do not affect the rest of the
document.
adjustbox
(Tex only.) A logical, numeric or character scalar, default is NULL. If not
NULL, the table is inserted within the adjustbox environment. By default the options are
width = 1\\textwidth, center (if TRUE). A numeric value changes the value before
\\textwidth. You can also add a character of the form "x tw" or "x th" with x a number
and where tw (th) stands for text-width (text-height). Finally any other character value is
passed verbatim as an adjustbox option.
fontsize
(Tex only.) A character scalar, default is NULL. Can be equal to tiny,
scriptsize, footnotesize, small, normalsize, large, or Large. The change affect the
table only (and not the rest of the document).
tabular
(Tex only.) Character scalar equal to "normal" (default), "*" or "X".
Represents the type of tabular environment to use: either tabular, tabular* or tabularx.
meta
(Tex only.) A one-sided formula that shall contain the following elements:
date or time, sys, author, comment and call. Default is NULL. This argument is a shortcut to
controlling the meta information that can be displayed in comments before the table. Typically
if the element is in the formula, it means that the argument will be equal to TRUE.
Example: meta = ~time+call is equivalent to meta.time = TRUE and meta.call = TRUE.
The "author" and "comment" elements are a bit special. Using meta = ~author("Mark") is
equivalent to meta.author = "Mark" while meta=~author is equiv. to meta.author = TRUE.
The "comment" must be used with a character string inside:
meta = ~comment("this is a comment"). The order in the formula controls the order of
appearance of the meta elements. It also has precedence over the meta.XX arguments.
meta.time
(Tex only.) Either a logical scalar (default is FALSE) or "time" or "date".
Whether to include the time (if TRUE or "time") or the date (if "date") of creation of the
table in a comment right before the table.
meta.author
(Tex only.) A logical scalar (default is FALSE) or a character vector. If
TRUE then the identity of the author (deduced from the system user in Sys.info()) is
inserted in a comment right before the table. If a character vector, then it should contain
author names that will be inserted as comments before the table, prefixed with "Created by:".
For free-form comments see the argument meta.comment.
meta.sys
(Tex only.) A logical scalar, default is FALSE. Whether to include system
information (from Sys.info()) in a comment right before the table.
meta.call
(Tex only.) Logical scalar, default is FALSE. If TRUE then the call to the
function is inserted right before the table in a comment.
meta.comment
(Tex only.) A character vector containing free-form comments to be inserted
right before the table.
view
Logical, default is FALSE. If TRUE, then the table generated in Latex by
etable and then is displayed in the viewer pane. Note that for this option to work you need
i) pdflatex or the R package tinytex, ii) imagemagick and ghostscript, or the
R package pdftools. All three software must be installed and on the path.
markdown
Character scalar giving the location of a directory, or a logical scalar.
Default is NULL. This argument only works in Rmarkdown documents, when knitting the document.
If provided: two behaviors depending on context. A) if the output document is Latex, the table
is exported in Latex. B) if the output document is not Latex, the table will be exported to PNG
at the desired location and inserted in the document via a markdown link. If equal to TRUE,
the default location of the PNGs is a temporary folder for R > 4.0.0,
or to "images/etable/" for earlier versions.
tex
Logical: whether the results should be a data.frame or a Latex table. By default,
this argument is TRUE if the argument file (used for exportation) is not missing; it is
equal to FALSE otherwise.
view.cache
Logical, default is TRUE. Only used when view = TRUE.
Whether the PNGs of the tables should be cached.
reset
(setFixest_etable only.) Logical, default is FALSE. If TRUE, this will reset
all the default values that were already set by the user in previous calls.
save
Either a logical or equal to "reset". Default is FALSE. If TRUE then the value
is set permanently at the project level, this means that if you restart R, you will still obtain
the previously saved defaults. This is done by writing in the ".Renviron" file, located in the
project's working directory, hence we must have write permission there for this to work, and
only works with Rstudio. If equal to "reset", the default at the project level is erased. Since
there is writing in a file involved, permission is asked to the user.
x
An object returned by etable.
type
Character scalar equal to 'pdflatex' (default), 'magick', 'dir' or 'tex'.
Which log file to report; if 'tex', the full source code of the tex file is returned,
if 'dir': the directory of the log files is returned.
Details
The function esttex is equivalent to the function etable with argument tex = TRUE.
The function esttable is equivalent to the function etable with argument tex = FALSE.
To display the table, you will need the Latex package booktabs which contains
the \\toprule, \\midrule and \\bottomrule commands.
You can permanently change the way your table looks in Latex by using setFixest_etable.
The following vignette gives an example as well as illustrates how to use the style and
postprocessing functions: Exporting estimation tables.
When the argument postprocess.tex is not missing, two additional tags will
be included in the character vector returned by etable:
"%start:tab\\n" and "%end:tab\\n". These can be used
to identify the start and end of the tabular and are useful to insert code
within the table environment.
Value
If tex = TRUE, the lines composing the Latex table are returned invisibly while
the table is directly prompted on the console.
If tex = FALSE, the data.frame is directly returned. If the argument file is
not missing, the data.frame is printed and returned invisibly.
Functions
-
esttable(): Exports the results of multiple fixest estimations in a Latex table.
-
esttex(): Exports the results of multiple fixest estimations in a Latex table.
Latex dependencies
Some features require specific Latex dependencies, these are:
always needed: \\usepackage{booktabs}, \\usepackage{array},
\\usepackage{multirow}, \\usepackage{amsmath}, \\usepackage{amssymb}
if there are line break within cells: \\usepackage{makecell}
if the tabularx environment is used: \\usepackage{tabularx}
if threeparttable notes are used: \\usepackage[flushleft]{threeparttable}
if you use adjustbox: \\usepackage{adjustbox}
if you use any kind of colors in the table: \\usepackage[dvipsnames,table]{xcolor}
if you highlight cells with a box: \\usepackage{tikz} and
\\usetikzlibrary{matrix, shapes, arrows, fit, tikzmark}
if you highlight rows using the background color: \\usepackage{colortbl}
Here is a summary:
% required
\usepackage{booktabs}
\usepackage{array}
\usepackage{multirow}
\usepackage{amsmath}
\usepackage{amssymb}
% optionnal, dependent on context
\usepackage{makecell}
\usepackage{tabularx}
\usepackage[flushleft]{threeparttable}
\usepackage{adjustbox}
\usepackage[dvipsnames,table]{xcolor}
\usepackage{tikz}
\usetikzlibrary{matrix, shapes, arrows, fit, tikzmark}
\usepackage{colortbl}
How does digits handle the number of decimals displayed?
The default display of decimals is the outcome of an algorithm. Let's take the example
of digits = 3 which "kind of" requires 3 significant digits to be displayed.
For numbers greater than 1 (in absolute terms), their integral part is
always displayed and the number of decimals shown is equal to digits
minus the number of digits in the integral part.
This means that 12.345 will be displayed as 12.3.
If the number of decimals should be 0, then a single decimal is displayed
to suggest that the number is not whole. This means that 1234.56 will
be displayed as 1234.5. Note that if the number is whole, no decimals are shown.
For numbers lower than 1 (in absolute terms), the number of decimals displayed is equal
to digits except if there are only 0s in which case the first significant
digit is shown.
This means that 0.01234 will be displayed as 0.012 (first rule),
and that 0.000123 will be displayed as 0.0001 (second rule).
Arguments keep, drop and order
The arguments keep, drop and order use regular expressions. If you are not aware
of regular expressions, I urge you to learn it, since it is an extremely powerful way
to manipulate character strings (and it exists across most programming languages).
For example drop = "Wind" would drop any variable whose name contains "Wind". Note that
variables such as "Temp:Wind" or "StrongWind" do contain "Wind", so would be dropped.
To drop only the variable named "Wind", you need to use
drop = "^Wind$" (with "^" meaning beginning, resp. "$" meaning end,
of the string => this is the language of regular expressions).
Although you can combine several regular expressions in a single character
string using pipes, drop also accepts a vector of regular expressions.
You can use the special character "!" (exclamation mark) to reverse the effect
of the regular expression (this feature is specific to this function).
For example drop = "!Wind" would drop any variable that does not contain "Wind".
By default, the regular expressions are checked against the variables after
they have been renamed with the dictionary (argument dict).
You can use the *_raw versions of drop/keep/order to apply the regular
expressions on the original variable names.
Note that alternatively you can use the special character "%" (percentage) at the
beginning of drop/keep/order's regular expressions to refer to the original variable name.
For example, you have a variable named "Month6",
and use a dictionary dict = c(Month6="June").
Thus the variable will be displayed as "June".
If you want to delete that variable, you can use either drop="June", drop_raw="Month6",
or drop="%Month6".
The argument order takes in a vector of regular expressions, the order will follow the
elements of this vector. The vector gives a list of priorities,
on the left the elements with highest priority.
For example, order = c("Wind", "!Inter", "!Temp") would give highest priorities to
the variables containing "Wind" (which would then appear first),
second highest priority is the variables not containing "Inter", last,
with lowest priority, the variables not containing "Temp".
If you had the following variables: (Intercept), Temp:Wind, Wind, Temp you
would end up with the following order: Wind, Temp:Wind, Temp, (Intercept).
The argument headers
Use the argument headers to add one or more lines in the header (top part of the table).
It accepts a list where each element of the list is a line, the names of the list
(if provided) are the row name.
The content (not the row name) of each line can be defined in two ways:
a character vector, or 2) a list.
If a vector, it should represent the values taken by each cell. Note that if the
length of the vector is smaller than the number of models, its values are
recycled across models, but the length of the vector is required to be a
divisor of the number of models.
If a list, it should be of the form list("item1" = nb1, "item2" = nb2, etc).
Numbers given as integers represent column positions.
For exemple: list("A" = 2L, "B" = 3L) leads
to c("", "A", "B").
Numbers in 'double' format (the default number format in R) represent spans.
For example: list("A"=2, "B"=3) leads to c("A", "A", "B", "B", "B").
Note that if the number of items is 1, you don't need to add = 1.
For example: list("A"=2, "B") is valid and leads to c("A", "A", "B").
The spans can be larger than the number of models (to fill all columns).
The resolution of spans or column positions is done from left to right.
The spans always start at the rightmost unfilled column on the right.
For example: list("A" = 2L, "B" = 2) lead to c("", "A", "B", "B").
Another example: list("B" = 3, "A" = 2L) leads to c("B", "A", "B").
Note that contrary to the vector (see point 1)) the values provided are
not recycled, instead the right side is filled with empty columns.
The only exception is when multiple VCOVs in the vcov argument leads to the repetition
of models, and in that case the values are recycled accordingly (if that does make sense).
The argument extralines
The argument extralines adds well... extra lines to the table.
It accepts either a list, or a one-sided formula.
For each line, you can define the values taken by each cell using 4 different ways:
a vector, 2) a list, 3) a function, and 4) a formula.
If a vector, it should represent the values taken by each cell. Note that if the
length of the vector is smaller than the number of models, its values are
recycled across models, but the length of the vector is required to be a
divisor of the number of models.
If a list, it should be of the form list("item1" = nb1, "item2" = nb2, etc).
Numbers given as integers represent column positions.
For exemple: list("A" = 2L, "B" = 3L) leads
to c("", "A", "B").
Numbers in 'double' format (the default number format in R) represent spans.
For example: list("A"=2, "B"=3) leads to c("A", "A", "B", "B", "B").
Note that if the number of items is 1, you don't need to add = 1.
For example: list("A"=2, "B") is valid and leads to c("A", "A", "B").
The spans can be larger than the number of models (to fill all columns).
The resolution of spans or column positions is done from left to right.
The spans always start at the rightmost unfilled column on the right.
For example: list("A" = 2L, "B" = 2) lead to c("", "A", "B", "B").
Another example: list("B" = 3, "A" = 2L) leads to c("B", "A", "B").
Note that contrary to the vector (see point 1)) the values provided are
not recycled, instead the right side is filled with empty columns.
The only exception is when multiple VCOVs in the vcov argument leads to the repetition
of models, and in that case the values are recycled accordingly (if that does make sense).
If a function, it will be applied to each model and should return a scalar (NA values
returned are accepted).
If a formula, it must be one-sided and the elements in the formula must represent either
extralines macros, either fit statistics (i.e. valid types of
the function fitstat).
One new line will be added for each element of the formula.
To register extralines macros, you must first register them in extralines_register.
Finally, you can combine as many lines as wished by nesting them in a list.
The names of the nesting list are the row titles (values in the leftmost cell).
For example extralines = list(~r2, Controls = TRUE, Group = list("A"=2, "B")) will
add three lines, the titles of which are "R2", "Controls" and "Group".
Controlling the placement of extra lines
The arguments group, extralines and fixef.group allow to add customized lines in the
table. They can be defined via a list where the list name will be the row name.
By default, the placement of the extra line is right after the coefficients
(except for fixef.group, covered in the last paragraph).
For instance, group = list("Controls" = "x[[:digit:]]") will create a
line right after the coefficients telling which models contain the control variables.
But the placement can be customized. The previous example (of the controls) will
be used for illustration (the mechanism for extralines and fixef.group is identical).
The row names accept 2 special characters at the very start.
The first character tells in which section the line should appear:
it can be equal to "^", "-", or "_", meaning respectively
the coefficients, the fixed-effects and the statistics section
(which typically appear at the top, mid and bottom of the table).
The second one governs the placement of the new line within
the section: it can be equal to "^", meaning first line, or "_", meaning last line.
Let's have some examples. Using the previous example, writing "_^Controls"
would place the new line at the top of the statistics section.
Writing "-_Controls" places it as the last row of
the fixed-effects section; "^^Controls" at the top row of
the coefficients section; etc...
The second character is optional, the default placement being in the bottom.
This means that "_Controls" would place it at the bottom of the statistics section.
The placement in fixef.group is defined similarly, only the default
placement is different.
Its default placement is at the top of the fixed-effects section.
Escaping special Latex characters
By default on all instances (with the notable exception of the elements of style.tex)
special Latex characters are escaped. This means that
caption="Exports in million $." will be exported as
"Exports in million \\$.": the dollar sign will be escaped.
This is true for the following characters: &, $, %, _, ^ and #.
Note, importantly, that equations are NOT escaped. This means that
caption="Functional form $a_i \\times x^b$, variation in %." will be displayed as:
"Functional form $a_i \\times x^b$, variation in \\%.": only the
last percentage will be escaped.
If for some reason you don't want the escaping to take place, the arguments headers and
extralines are the only ones allowing that. To disable escaping, add the special token
":tex:" in the row names.
Example: in headers=list(":tex:Row title"="weird & & %\\n tex stuff\\\\"),
the elements will be displayed verbatim. Of course, since it can easily ruin your table,
it is only recommended to super users.
Markdown markup
Within anything that is Latex-escaped (see previous section), you can use a markdown-style
markup to put the text in italic and/or bold. Use *text*, **text** or ***text*** to
put some text in, respectively, italic (with \\textit),
bold (with \\textbf) and italic-bold.
The markup can be escaped by using an backslash first. For example "***This: \\***, are three stars***" will leave the three stars in the middle untouched.
Author(s)
Laurent Berge
See Also
For styling the table: setFixest_etable, style.tex, style.df.
See also the main estimation functions femlm, feols or feglm.
Use summary.fixest
to see the results with the appropriate standard-errors, fixef.fixest to extract the
fixed-effects coefficients.
Examples
# Two similar estimations: one with the other without fixed-effects
est1 = feols(Ozone ~ i(Month) / Wind + Temp, data = airquality)
est2 = feols(Ozone ~ i(Month, Wind) + Temp | Month, data = airquality)
# Displaying the two results in a single table
etable(est1, est2)
# keep/drop: keeping only interactions
etable(est1, est2, keep = " x ")
# or using drop (see regexp help):
etable(est1, est2, drop = "^(Month|Temp|Cons)")
# keep/drop: dropping interactions
etable(est1, est2, drop = " x ")
# or using keep ("!" reverses the effect):
etable(est1, est2, keep = "! x ")
# order: Wind variable first, intercept last (note the "!" to reverse the effect)
etable(est1, est2, order = c("Wind", "!Const"))
# Month, then interactions, then the rest
etable(est1, est2, order = c("^Month", " x "))
#
# dict
#
# You can rename variables with dict = c(var1 = alias1, var2 = alias2, etc)
# You can also rename values taken by factors.
# Here's a full example:
dict = c(Temp = "Temperature", "Month::5"="May", "6"="Jun")
etable(est1, est2, dict = dict)
# Note the difference of treatment between Jun and May
# Assume the following dictionary:
dict = c("Month::5"="May", "Month::6"="Jun", "Month::7"="Jul",
"Month::8"="Aug", "Month::9"="Sep")
# We would like to keep only the Months, but now the names are all changed...
# How to do?
# We can use the argument keep_raw to make reference to the original names.
etable(est1, est2, dict = dict, keep_raw = "Month")
# Alternatively, we can use the special character '%' to make reference to the original names
etable(est1, est2, dict = dict, keep = "%Month")
#
# coef.sub
#
# Let's use a regular expression to add parentheses around Month, in its product with Wind
# [NOTA: this is a complex example just to illustrate how to use a regex with coef.sub]
etable(est1, est2, coef.sub = "x M(.+)$ => x (M\\1)")
#
# signif.code
#
etable(est1, est2, signif.code = c(" A"=0.01, " B"=0.05, " C"=0.1, " D"=0.15, " F"=1))
#
# Using the argument style to customize Latex exports
#
# If you don't like the default layout of the table, no worries!
# You can modify many parameters with the argument style
# To drop the headers before each section, use:
# Note that a space adds an extra line
style_noHeaders = style.tex(var.title = "", fixef.title = "", stats.title = " ")
etable(est1, est2, dict = dict, tex = TRUE, style.tex = style_noHeaders)
# To change the lines of the table + dropping the table footer
style_lines = style.tex(line.top = "\\toprule", line.bottom = "\\bottomrule",
tablefoot = FALSE)
etable(est1, est2, dict = dict, tex = TRUE, style.tex = style_lines)
# Or you have the predefined type "aer"
etable(est1, est2, dict = dict, tex = TRUE, style.tex = style.tex("aer"))
#
# Group and extralines
#
# Sometimes it's useful to group control variables into a single line
# You can achieve that with the group argument
setFixest_fml(..ctrl = ~ poly(Wind, 2) + poly(Temp, 2))
est_c0 = feols(Ozone ~ Solar.R, data = airquality)
est_c1 = feols(Ozone ~ Solar.R + ..ctrl, data = airquality)
est_c2 = feols(Ozone ~ Solar.R + Solar.R^2 + ..ctrl, data = airquality)
etable(est_c0, est_c1, est_c2, group = list(Controls = "poly"))
# 'group' here does the same as drop = "poly", but adds an extra line
# with TRUE/FALSE where the variables were found
# 'extralines' adds an extra line, where you can add the value for each model
est_all = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality)
est_sub1 = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality,
subset = ~ Month %in% 5:6)
est_sub2 = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality,
subset = ~ Month %in% 7:8)
est_sub3 = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality,
subset = ~ Month == 9)
etable(est_all, est_sub1, est_sub2, est_sub3,
extralines = list("Sub-sample" = c("All", "May-June", "Jul.-Aug.", "Sept.")))
# You can monitor the placement of the new lines with two special characters
# at the beginning of the row name.
# 1) "^", "-" or "_" which mean the coefficients, the fixed-effects or the
# statistics section.
# 2) "^" or "_" which mean first or last line of the section
#
# Ex: starting with "_^" will place the line at the top of the stat. section
# starting with "-_" will place the line at the bottom of the FEs section
# etc.
#
# You can use a single character which will represent the section,
# the line would then appear at the bottom of the section.
# Examples
etable(est_c0, est_c1, est_c2, group = list("_Controls" = "poly"))
etable(est_all, est_sub1, est_sub2, est_sub3,
extralines = list("^^Sub-sample" = c("All", "May-June", "Jul.-Aug.", "Sept.")))
#
# headers
#
# You can add header lines with 'headers'
# These lines will appear at the top of the table
# first, 3 estimations
est_header = feols(c(Ozone, Solar.R, Wind) ~ poly(Temp, 2), airquality)
# header => vector: adds a line w/t title
etable(est_header, headers = c("A", "A", "B"))
# header => list: identical way to do the previous header
# The form is: list(item1 = #item1, item2 = #item2, etc)
etable(est_header, headers = list("A" = 2, "B" = 1))
# Adding a title +
# when an element is to be repeated only once, you can avoid the "= 1":
etable(est_header, headers = list(Group = list("A" = 2, "B")))
# To change the placement, add as first character:
# - "^" => top
# - "-" => mid (default)
# - "_" => bottom
# Note that "mid" and "top" are only distinguished when tex = TRUE
# Placing the new header line at the bottom
etable(est_header, headers = list("_Group" = c("A", "A", "B"),
"^Currency" = list("US $" = 2, "CA $" = 1)))
# In Latex, you can add "grouped underlines" (cmidrule from the booktabs package)
# by adding ":_:" in the title:
etable(est_header, tex = TRUE,
headers = list("^:_:Group" = c("A", "A", "B")))
#
# extralines and headers: .() for list()
#
# In the two arguments extralines and headers, .() can be used for list()
# For example:
etable(est_header, headers = .("^Currency" = .("US $" = 2, "CA $" = 1)))
#
# fixef.group
#
# You can group the fixed-effects line with fixef.group
est_0fe = feols(Ozone ~ Solar.R + Temp + Wind, airquality)
est_1fe = feols(Ozone ~ Solar.R + Temp + Wind | Month, airquality)
est_2fe = feols(Ozone ~ Solar.R + Temp + Wind | Month + Day, airquality)
# A) automatic way => simply use fixef.group = TRUE
etable(est_0fe, est_2fe, fixef.group = TRUE)
# Note that when grouping would lead to inconsistencies across models,
# it is avoided
etable(est_0fe, est_1fe, est_2fe, fixef.group = TRUE)
# B) customized way => use a list
etable(est_0fe, est_2fe, fixef.group = list("Dates" = "Month|Day"))
# Note that when a user grouping would lead to inconsistencies,
# the term partial replaces yes/no and the fixed-effects are not removed.
etable(est_0fe, est_1fe, est_2fe, fixef.group = list("Dates" = "Month|Day"))
# Using customized placement => as with 'group' and 'extralines',
# the user can control the placement of the new line.
# See the previous 'group' examples and the dedicated section in the help.
# On top of the coefficients:
etable(est_0fe, est_2fe, fixef.group = list("^^Dates" = "Month|Day"))
# Last line of the statistics
etable(est_0fe, est_2fe, fixef.group = list("_Dates" = "Month|Day"))
#
# Using custom functions to compute the standard errors
#
# You can use external functions to compute the VCOVs
# by feeding functions in the 'vcov' argument.
# Let's use some covariances from the sandwich package
etable(est_c0, est_c1, est_c2, vcov = sandwich::vcovHC)
# To add extra arguments to vcovHC, you need to write your wrapper:
etable(est_c0, est_c1, est_c2, vcov = function(x) sandwich::vcovHC(x, type = "HC0"))
#
# Customize which fit statistic to display
#
# You can change the fit statistics with the argument fitstat
# and you can rename them with the dictionary
etable(est1, est2, fitstat = ~ r2 + n + G)
# If you use a formula, '.' means the default:
etable(est1, est2, fitstat = ~ ll + .)
#
# Computing a different SE for each model
#
est = feols(Ozone ~ Solar.R + Wind + Temp, data = airquality)
#
# Method 1: use summary
s1 = summary(est, "iid")
s2 = summary(est, cluster = ~ Month)
s3 = summary(est, cluster = ~ Day)
s4 = summary(est, cluster = ~ Day + Month)
etable(list(s1, s2, s3, s4))
#
# Method 2: using a list in the argument 'vcov'
est_bis = feols(Ozone ~ Solar.R + Wind + Temp | Month, data = airquality)
etable(est, est_bis, vcov = list("hetero", ~ Month))
# When you have only one model, this model is replicated
# along the elements of the vcov list.
etable(est, vcov = list("hetero", ~ Month))
#
# Method 3: Using "each" or "times" in vcov
# If the first element of the list in 'vcov' is "each" or "times",
# then all models will be replicated and all the VCOVs will be
# applied to each model. The order in which they are replicated
# are governed by the each/times keywords.
# each
etable(est, est_bis, vcov = list("each", "iid", ~ Month, ~ Day))
# times
etable(est, est_bis, vcov = list("times", "iid", ~ Month, ~ Day))
#
# Notes and markup
#
# Notes can be also be set in a dictionary
# You can use markdown markup to put text into italic/bold
dict = c("note 1" = "*Notes:* This data is not really random.",
"source 1" = "**Source:** the internet?")
est = feols(Ozone ~ csw(Solar.R, Wind, Temp), data = airquality)
etable(est, dict = dict, tex = TRUE, notes = c("note 1", "source 1"))
fixest documentation built on March 18, 2026, 9:06 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| esttable | R Documentation |
Estimations table (export the results of multiples estimations to a DF or to Latex)
Description
Aggregates the results of multiple estimations and displays them in the form of either a Latex
table or a data.frame. Note that you will need the booktabs package for the Latex table to
render properly. See setFixest_etable to set the default values, and style.tex to customize Latex output.
Usage
esttable(
...,
vcov = NULL,
stage = 2,
agg = NULL,
se = NULL,
ssc = NULL,
cluster = NULL,
.vcov_args = NULL,
digits = 4,
digits.stats = 5,
fitstat = NULL,
coefstat = "se",
ci = 0.95,
se.row = NULL,
se.below = NULL,
keep = NULL,
drop = NULL,
order = NULL,
keep_raw = NULL,
drop_raw = NULL,
order_raw = NULL,
dict = TRUE,
coef.sub = NULL,
file = NULL,
replace = TRUE,
create_dirs = FALSE,
convergence = NULL,
signif.code = NULL,
headers = list("auto"),
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
keepFactors = TRUE,
family = NULL,
powerBelow = -5,
interaction.combine = NULL,
interaction.order = NULL,
i.equal = NULL,
depvar = TRUE,
style.df = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
drop.section = NULL,
poly_dict = c("", " square", " cube"),
postprocess.df = NULL,
fit_format = "__var__",
coef.just = NULL,
highlight = NULL,
coef.style = NULL,
export = NULL,
page.width = "fit",
div.class = "etable"
)
esttex(
...,
vcov = NULL,
stage = 2,
agg = NULL,
se = NULL,
ssc = NULL,
cluster = NULL,
.vcov_args = NULL,
digits = 4,
digits.stats = 5,
fitstat = NULL,
caption = NULL,
coefstat = "se",
ci = 0.95,
se.row = NULL,
se.below = NULL,
keep = NULL,
drop = NULL,
order = NULL,
keep_raw = NULL,
drop_raw = NULL,
order_raw = NULL,
dict = TRUE,
coef.sub = NULL,
file = NULL,
replace = TRUE,
create_dirs = FALSE,
convergence = NULL,
signif.code = NULL,
label = NULL,
float = NULL,
headers = list("auto"),
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
keepFactors = TRUE,
family = NULL,
powerBelow = -5,
interaction.combine = NULL,
interaction.order = NULL,
i.equal = NULL,
depvar = TRUE,
style.tex = NULL,
notes = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
placement = "htbp",
drop.section = NULL,
poly_dict = c("", " square", " cube"),
postprocess.tex = NULL,
tpt = FALSE,
arraystretch = NULL,
adjustbox = NULL,
fontsize = NULL,
fit_format = "__var__",
tabular = "normal",
highlight = NULL,
coef.style = NULL,
meta = NULL,
meta.time = NULL,
meta.author = NULL,
meta.sys = NULL,
meta.call = NULL,
meta.comment = NULL,
view = FALSE,
export = NULL,
markdown = NULL,
page.width = "fit",
div.class = "etable"
)
etable(
...,
vcov = NULL,
stage = 2,
agg = NULL,
se = NULL,
ssc = NULL,
cluster = NULL,
.vcov_args = NULL,
digits = 4,
digits.stats = 5,
tex,
fitstat = NULL,
caption = NULL,
coefstat = "se",
ci = 0.95,
se.row = NULL,
se.below = NULL,
keep = NULL,
drop = NULL,
order = NULL,
keep_raw = NULL,
drop_raw = NULL,
order_raw = NULL,
dict = TRUE,
coef.sub = NULL,
file = NULL,
replace = TRUE,
create_dirs = FALSE,
convergence = NULL,
signif.code = NULL,
label = NULL,
float = NULL,
headers = list("auto"),
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
keepFactors = TRUE,
family = NULL,
powerBelow = -5,
interaction.combine = NULL,
interaction.order = NULL,
i.equal = NULL,
depvar = TRUE,
style.tex = NULL,
style.df = NULL,
notes = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
placement = "htbp",
drop.section = NULL,
poly_dict = c("", " square", " cube"),
postprocess.tex = NULL,
postprocess.df = NULL,
tpt = FALSE,
arraystretch = NULL,
adjustbox = NULL,
fontsize = NULL,
fit_format = "__var__",
coef.just = NULL,
tabular = "normal",
highlight = NULL,
coef.style = NULL,
meta = NULL,
meta.time = NULL,
meta.author = NULL,
meta.sys = NULL,
meta.call = NULL,
meta.comment = NULL,
view = FALSE,
export = NULL,
markdown = NULL,
page.width = "fit",
div.class = "etable"
)
setFixest_etable(
digits = 4,
digits.stats = 5,
fitstat,
coefstat = c("se", "tstat", "confint", "pvalue"),
ci = 0.95,
se.below = TRUE,
keep,
drop,
order,
dict,
float,
signif.code = NULL,
fixef_sizes = FALSE,
fixef_sizes.simplify = TRUE,
family,
powerBelow = -5,
interaction.order = NULL,
depvar,
style.tex = NULL,
style.df = NULL,
notes = NULL,
group = NULL,
extralines = NULL,
fixef.group = NULL,
placement = "htbp",
drop.section = NULL,
view = FALSE,
markdown = NULL,
view.cache = TRUE,
page.width = "fit",
div.class = "etable",
postprocess.tex = NULL,
postprocess.df = NULL,
fit_format = "__var__",
meta.time = NULL,
meta.author = NULL,
meta.sys = NULL,
meta.call = NULL,
meta.comment = NULL,
reset = FALSE,
save = FALSE
)
getFixest_etable()
## S3 method for class 'etable_tex'
print(x, ...)
## S3 method for class 'etable_df'
print(x, ...)
log_etable(type = "pdflatex")
Arguments
... |
Used to capture different |
vcov |
Versatile argument to specify the VCOV.
In general, it is either a character scalar equal to a VCOV type, either a formula of the form:
vcov_type ~ variables. The VCOV types implemented are: "iid", "hetero" (or "HC1"),
"cluster", "twoway", "NW" (or "newey_west"), "DK" (or "driscoll_kraay"), and "conley".
It also accepts object from vcov_cluster, vcov_NW, NW, vcov_DK, DK, vcov_conley and conley.
It also accepts covariance matrices computed externally.
Finally it accepts functions to compute the covariances.
See the vcov documentation in the vignette.
You can pass several VCOVs (as above) if you nest them into a list.
If the number of VCOVs equals the number of models, eahc VCOV is mapped to the appropriate model.
If there is one model and several VCOVs, or if the first element of the list is equal to
|
stage |
Can be equal to |
agg |
A character scalar describing the variable names to be aggregated,
it is pattern-based. For |
se |
Character scalar. Which kind of standard error should be computed:
“standard”, “hetero”, “cluster”, “twoway”, “threeway”
or “fourway”? By default if there are clusters in the estimation:
|
ssc |
An object of class |
cluster |
Tells how to cluster the standard-errors (if clustering is requested).
Can be either a list of vectors, a character vector of variable names, a formula or
an integer vector. Assume we want to perform 2-way clustering over |
.vcov_args |
A list containing arguments to be passed to the function |
digits |
Integer or character scalar. Default is 4 and represents the number of significant
digits to be displayed for the coefficients and standard-errors. To apply rounding instead of
significance use, e.g., |
digits.stats |
Integer or character scalar. Default is 5 and represents the number of
significant digits to be displayed for the fit statistics. To apply rounding instead of
significance use, e.g., |
fitstat |
A character vector or a one sided formula (both with only lowercase letters). A
vector listing which fit statistics to display. The valid types are 'n', 'll', 'aic', 'bic' and
r2 types like 'r2', 'pr2', 'war2', etc (see all valid types in |
coefstat |
One of |
ci |
Level of the confidence interval, defaults to |
se.row |
Logical scalar, default is |
se.below |
Logical or |
keep |
Character vector. This element is used to display only a subset of variables. This
should be a vector of regular expressions (see Example: you have the variable |
drop |
Character vector. This element is used if some variables are not to be displayed.
This should be a vector of regular expressions (see Example: you have the variable |
order |
Character vector. This element is used if the user wants the variables to be
ordered in a certain way. This should be a vector of regular expressions (see Example: you have the following variables: |
keep_raw |
Character vector. This element is used to display only a subset of variables.
This should be a vector of regular expressions (see Example: you have the variable |
drop_raw |
Character vector. This element is used if some variables are not to
be displayed.
This should be a vector of regular expressions (see Example: you have the variable |
order_raw |
Character vector. This element is used if the user wants the variables to be
ordered in a certain way. This should be a vector of regular expressions (see Example: you have the following variables: |
dict |
A named character vector or a logical scalar. It changes the original variable names
to the ones contained in the |
coef.sub |
A character vector, default is This internal function applying the changes is |
file |
A character scalar. If provided, the Latex (or data frame) table will be saved in a
file whose path is |
replace |
Logical, default is |
create_dirs |
Logical, default is |
convergence |
Logical, default is missing. Should the convergence state of the algorithm be displayed? By default, convergence information is displayed if at least one model did not converge. |
signif.code |
Named numeric vector, used to provide the significance codes with respect to
the p-value of the coefficients. Default is |
headers |
Character vector or list. Adds one or more header lines in the table. A header
line can be represented by a character vector or a named list.
This argument can be many things, please have a look at the dedicated help section;
a simplified description follows.
If a named list, each element of the list represents a line, the names of the list are
the row names and the values are the content of the cells.
A line can be represented by: i) a character vector, ii) a list of the form
|
fixef_sizes |
(Tex only.) Logical, default is |
fixef_sizes.simplify |
Logical, default is |
keepFactors |
Logical, default is |
family |
Logical, default is missing. Whether to display the families of the models. By default this line is displayed when at least two models are from different families. |
powerBelow |
(Tex only.) Integer, default is -5. A coefficient whose value is below
|
interaction.combine |
Character scalar, defaults to |
interaction.order |
Character vector of regular expressions. Only affects variables that
are interacted like x1 and x2 in |
i.equal |
Character scalar, defaults to |
depvar |
Logical, default is |
style.df |
An object created by the function |
group |
A list. The list elements should be vectors of regular expressions. For each
elements of this list: A new line in the table is created, all variables that are matched by the
regular expressions are discarded (same effect as the argument |
extralines |
A vector, a list or a one sided formula. The list elements should be either a
vector representing the value of each cell, a list of the form
|
fixef.group |
Logical scalar or list (default is |
drop.section |
Character vector which can be of length 0 (i.e. equal to |
poly_dict |
Character vector, default is |
postprocess.df |
A function that will postprocess.tex the resulting data.frame. Only when
|
fit_format |
Character scalar, default is |
coef.just |
(DF only.) Either |
highlight |
List containing coefficients to highlight.
Highlighting is of the form To be able to use use the highlighting feature, you need the
following lines in your latex preamble: |
coef.style |
Named list containing styles to be applied to the coefficients. It must be of
the form |
export |
Character scalar giving the path to a PNG file to be created, default is |
page.width |
Character scalar equal to |
div.class |
Character scalar, default is |
caption |
(Tex only.) Character scalar. The caption of the Latex table. |
label |
(Tex only.) Character scalar. The label of the Latex table. |
float |
(Tex only.) Logical. By default, if the argument |
style.tex |
An object created by the function |
notes |
(Tex only.) Character vector. If provided, a |
placement |
(Tex only.) Character string giving the position of the float in Latex. Default is "htbp". It must consist of only the characters 'h', 't', 'b', 'p', 'H' and '!'. Reminder: h: here; t: top; b: bottom; p: float page; H: definitely here; !: prevents Latex to look for other positions. Note that it can be equal to the empty string (and you'll get the default placement). |
postprocess.tex |
A function that will postprocess the character vector defining the latex
table. Only when |
tpt |
(Tex only.) Logical scalar, default is FALSE. Whether to use the |
arraystretch |
(Tex only.) A numeric scalar, default is |
adjustbox |
(Tex only.) A logical, numeric or character scalar, default is |
fontsize |
(Tex only.) A character scalar, default is |
tabular |
(Tex only.) Character scalar equal to "normal" (default), |
meta |
(Tex only.) A one-sided formula that shall contain the following elements:
date or time, sys, author, comment and call. Default is |
meta.time |
(Tex only.) Either a logical scalar (default is |
meta.author |
(Tex only.) A logical scalar (default is |
meta.sys |
(Tex only.) A logical scalar, default is |
meta.call |
(Tex only.) Logical scalar, default is |
meta.comment |
(Tex only.) A character vector containing free-form comments to be inserted right before the table. |
view |
Logical, default is |
markdown |
Character scalar giving the location of a directory, or a logical scalar.
Default is |
tex |
Logical: whether the results should be a data.frame or a Latex table. By default,
this argument is |
view.cache |
Logical, default is |
reset |
( |
save |
Either a logical or equal to |
x |
An object returned by |
type |
Character scalar equal to 'pdflatex' (default), 'magick', 'dir' or 'tex'. Which log file to report; if 'tex', the full source code of the tex file is returned, if 'dir': the directory of the log files is returned. |
Details
The function esttex is equivalent to the function etable with argument tex = TRUE.
The function esttable is equivalent to the function etable with argument tex = FALSE.
To display the table, you will need the Latex package booktabs which contains
the \\toprule, \\midrule and \\bottomrule commands.
You can permanently change the way your table looks in Latex by using setFixest_etable.
The following vignette gives an example as well as illustrates how to use the style and
postprocessing functions: Exporting estimation tables.
When the argument postprocess.tex is not missing, two additional tags will
be included in the character vector returned by etable:
"%start:tab\\n" and "%end:tab\\n". These can be used
to identify the start and end of the tabular and are useful to insert code
within the table environment.
Value
If tex = TRUE, the lines composing the Latex table are returned invisibly while
the table is directly prompted on the console.
If tex = FALSE, the data.frame is directly returned. If the argument file is
not missing, the data.frame is printed and returned invisibly.
Functions
-
esttable(): Exports the results of multiplefixestestimations in a Latex table. -
esttex(): Exports the results of multiplefixestestimations in a Latex table.
Latex dependencies
Some features require specific Latex dependencies, these are:
always needed:
\\usepackage{booktabs},\\usepackage{array},\\usepackage{multirow},\\usepackage{amsmath},\\usepackage{amssymb}if there are line break within cells:
\\usepackage{makecell}if the tabularx environment is used:
\\usepackage{tabularx}if threeparttable notes are used:
\\usepackage[flushleft]{threeparttable}if you use adjustbox:
\\usepackage{adjustbox}if you use any kind of colors in the table:
\\usepackage[dvipsnames,table]{xcolor}if you highlight cells with a box:
\\usepackage{tikz}and\\usetikzlibrary{matrix, shapes, arrows, fit, tikzmark}if you highlight rows using the background color:
\\usepackage{colortbl}
Here is a summary:
% required
\usepackage{booktabs}
\usepackage{array}
\usepackage{multirow}
\usepackage{amsmath}
\usepackage{amssymb}
% optionnal, dependent on context
\usepackage{makecell}
\usepackage{tabularx}
\usepackage[flushleft]{threeparttable}
\usepackage{adjustbox}
\usepackage[dvipsnames,table]{xcolor}
\usepackage{tikz}
\usetikzlibrary{matrix, shapes, arrows, fit, tikzmark}
\usepackage{colortbl}
How does digits handle the number of decimals displayed?
The default display of decimals is the outcome of an algorithm. Let's take the example
of digits = 3 which "kind of" requires 3 significant digits to be displayed.
For numbers greater than 1 (in absolute terms), their integral part is
always displayed and the number of decimals shown is equal to digits
minus the number of digits in the integral part.
This means that 12.345 will be displayed as 12.3.
If the number of decimals should be 0, then a single decimal is displayed
to suggest that the number is not whole. This means that 1234.56 will
be displayed as 1234.5. Note that if the number is whole, no decimals are shown.
For numbers lower than 1 (in absolute terms), the number of decimals displayed is equal
to digits except if there are only 0s in which case the first significant
digit is shown.
This means that 0.01234 will be displayed as 0.012 (first rule),
and that 0.000123 will be displayed as 0.0001 (second rule).
Arguments keep, drop and order
The arguments keep, drop and order use regular expressions. If you are not aware
of regular expressions, I urge you to learn it, since it is an extremely powerful way
to manipulate character strings (and it exists across most programming languages).
For example drop = "Wind" would drop any variable whose name contains "Wind". Note that
variables such as "Temp:Wind" or "StrongWind" do contain "Wind", so would be dropped.
To drop only the variable named "Wind", you need to use
drop = "^Wind$" (with "^" meaning beginning, resp. "$" meaning end,
of the string => this is the language of regular expressions).
Although you can combine several regular expressions in a single character
string using pipes, drop also accepts a vector of regular expressions.
You can use the special character "!" (exclamation mark) to reverse the effect
of the regular expression (this feature is specific to this function).
For example drop = "!Wind" would drop any variable that does not contain "Wind".
By default, the regular expressions are checked against the variables after
they have been renamed with the dictionary (argument dict).
You can use the *_raw versions of drop/keep/order to apply the regular
expressions on the original variable names.
Note that alternatively you can use the special character "%" (percentage) at the
beginning of drop/keep/order's regular expressions to refer to the original variable name.
For example, you have a variable named "Month6",
and use a dictionary dict = c(Month6="June").
Thus the variable will be displayed as "June".
If you want to delete that variable, you can use either drop="June", drop_raw="Month6",
or drop="%Month6".
The argument order takes in a vector of regular expressions, the order will follow the
elements of this vector. The vector gives a list of priorities,
on the left the elements with highest priority.
For example, order = c("Wind", "!Inter", "!Temp") would give highest priorities to
the variables containing "Wind" (which would then appear first),
second highest priority is the variables not containing "Inter", last,
with lowest priority, the variables not containing "Temp".
If you had the following variables: (Intercept), Temp:Wind, Wind, Temp you
would end up with the following order: Wind, Temp:Wind, Temp, (Intercept).
The argument headers
Use the argument headers to add one or more lines in the header (top part of the table).
It accepts a list where each element of the list is a line, the names of the list
(if provided) are the row name.
The content (not the row name) of each line can be defined in two ways:
a character vector, or 2) a list.
If a vector, it should represent the values taken by each cell. Note that if the length of the vector is smaller than the number of models, its values are recycled across models, but the length of the vector is required to be a divisor of the number of models.
If a list, it should be of the form
list("item1" = nb1, "item2" = nb2, etc). Numbers given as integers represent column positions. For exemple:list("A" = 2L, "B" = 3L)leads toc("", "A", "B").
Numbers in 'double' format (the default number format in R) represent spans.
For example: list("A"=2, "B"=3) leads to c("A", "A", "B", "B", "B").
Note that if the number of items is 1, you don't need to add = 1.
For example: list("A"=2, "B") is valid and leads to c("A", "A", "B").
The spans can be larger than the number of models (to fill all columns).
The resolution of spans or column positions is done from left to right.
The spans always start at the rightmost unfilled column on the right.
For example: list("A" = 2L, "B" = 2) lead to c("", "A", "B", "B").
Another example: list("B" = 3, "A" = 2L) leads to c("B", "A", "B").
Note that contrary to the vector (see point 1)) the values provided are
not recycled, instead the right side is filled with empty columns.
The only exception is when multiple VCOVs in the vcov argument leads to the repetition
of models, and in that case the values are recycled accordingly (if that does make sense).
The argument extralines
The argument extralines adds well... extra lines to the table.
It accepts either a list, or a one-sided formula.
For each line, you can define the values taken by each cell using 4 different ways:
a vector, 2) a list, 3) a function, and 4) a formula.
If a vector, it should represent the values taken by each cell. Note that if the length of the vector is smaller than the number of models, its values are recycled across models, but the length of the vector is required to be a divisor of the number of models.
If a list, it should be of the form
list("item1" = nb1, "item2" = nb2, etc). Numbers given as integers represent column positions. For exemple:list("A" = 2L, "B" = 3L)leads toc("", "A", "B").
Numbers in 'double' format (the default number format in R) represent spans.
For example: list("A"=2, "B"=3) leads to c("A", "A", "B", "B", "B").
Note that if the number of items is 1, you don't need to add = 1.
For example: list("A"=2, "B") is valid and leads to c("A", "A", "B").
The spans can be larger than the number of models (to fill all columns).
The resolution of spans or column positions is done from left to right.
The spans always start at the rightmost unfilled column on the right.
For example: list("A" = 2L, "B" = 2) lead to c("", "A", "B", "B").
Another example: list("B" = 3, "A" = 2L) leads to c("B", "A", "B").
Note that contrary to the vector (see point 1)) the values provided are
not recycled, instead the right side is filled with empty columns.
The only exception is when multiple VCOVs in the vcov argument leads to the repetition
of models, and in that case the values are recycled accordingly (if that does make sense).
If a function, it will be applied to each model and should return a scalar (
NAvalues returned are accepted).If a formula, it must be one-sided and the elements in the formula must represent either
extralinesmacros, either fit statistics (i.e. valid types of the functionfitstat). One new line will be added for each element of the formula. To registerextralinesmacros, you must first register them inextralines_register.
Finally, you can combine as many lines as wished by nesting them in a list.
The names of the nesting list are the row titles (values in the leftmost cell).
For example extralines = list(~r2, Controls = TRUE, Group = list("A"=2, "B")) will
add three lines, the titles of which are "R2", "Controls" and "Group".
Controlling the placement of extra lines
The arguments group, extralines and fixef.group allow to add customized lines in the
table. They can be defined via a list where the list name will be the row name.
By default, the placement of the extra line is right after the coefficients
(except for fixef.group, covered in the last paragraph).
For instance, group = list("Controls" = "x[[:digit:]]") will create a
line right after the coefficients telling which models contain the control variables.
But the placement can be customized. The previous example (of the controls) will
be used for illustration (the mechanism for extralines and fixef.group is identical).
The row names accept 2 special characters at the very start.
The first character tells in which section the line should appear:
it can be equal to "^", "-", or "_", meaning respectively
the coefficients, the fixed-effects and the statistics section
(which typically appear at the top, mid and bottom of the table).
The second one governs the placement of the new line within
the section: it can be equal to "^", meaning first line, or "_", meaning last line.
Let's have some examples. Using the previous example, writing "_^Controls"
would place the new line at the top of the statistics section.
Writing "-_Controls" places it as the last row of
the fixed-effects section; "^^Controls" at the top row of
the coefficients section; etc...
The second character is optional, the default placement being in the bottom.
This means that "_Controls" would place it at the bottom of the statistics section.
The placement in fixef.group is defined similarly, only the default
placement is different.
Its default placement is at the top of the fixed-effects section.
Escaping special Latex characters
By default on all instances (with the notable exception of the elements of style.tex)
special Latex characters are escaped. This means that
caption="Exports in million $." will be exported as
"Exports in million \\$.": the dollar sign will be escaped.
This is true for the following characters: &, $, %, _, ^ and #.
Note, importantly, that equations are NOT escaped. This means that
caption="Functional form $a_i \\times x^b$, variation in %." will be displayed as:
"Functional form $a_i \\times x^b$, variation in \\%.": only the
last percentage will be escaped.
If for some reason you don't want the escaping to take place, the arguments headers and
extralines are the only ones allowing that. To disable escaping, add the special token
":tex:" in the row names.
Example: in headers=list(":tex:Row title"="weird & & %\\n tex stuff\\\\"),
the elements will be displayed verbatim. Of course, since it can easily ruin your table,
it is only recommended to super users.
Markdown markup
Within anything that is Latex-escaped (see previous section), you can use a markdown-style
markup to put the text in italic and/or bold. Use *text*, **text** or ***text*** to
put some text in, respectively, italic (with \\textit),
bold (with \\textbf) and italic-bold.
The markup can be escaped by using an backslash first. For example "***This: \\***, are three stars***" will leave the three stars in the middle untouched.
Author(s)
Laurent Berge
See Also
For styling the table: setFixest_etable, style.tex, style.df.
See also the main estimation functions femlm, feols or feglm.
Use summary.fixest
to see the results with the appropriate standard-errors, fixef.fixest to extract the
fixed-effects coefficients.
Examples
# Two similar estimations: one with the other without fixed-effects
est1 = feols(Ozone ~ i(Month) / Wind + Temp, data = airquality)
est2 = feols(Ozone ~ i(Month, Wind) + Temp | Month, data = airquality)
# Displaying the two results in a single table
etable(est1, est2)
# keep/drop: keeping only interactions
etable(est1, est2, keep = " x ")
# or using drop (see regexp help):
etable(est1, est2, drop = "^(Month|Temp|Cons)")
# keep/drop: dropping interactions
etable(est1, est2, drop = " x ")
# or using keep ("!" reverses the effect):
etable(est1, est2, keep = "! x ")
# order: Wind variable first, intercept last (note the "!" to reverse the effect)
etable(est1, est2, order = c("Wind", "!Const"))
# Month, then interactions, then the rest
etable(est1, est2, order = c("^Month", " x "))
#
# dict
#
# You can rename variables with dict = c(var1 = alias1, var2 = alias2, etc)
# You can also rename values taken by factors.
# Here's a full example:
dict = c(Temp = "Temperature", "Month::5"="May", "6"="Jun")
etable(est1, est2, dict = dict)
# Note the difference of treatment between Jun and May
# Assume the following dictionary:
dict = c("Month::5"="May", "Month::6"="Jun", "Month::7"="Jul",
"Month::8"="Aug", "Month::9"="Sep")
# We would like to keep only the Months, but now the names are all changed...
# How to do?
# We can use the argument keep_raw to make reference to the original names.
etable(est1, est2, dict = dict, keep_raw = "Month")
# Alternatively, we can use the special character '%' to make reference to the original names
etable(est1, est2, dict = dict, keep = "%Month")
#
# coef.sub
#
# Let's use a regular expression to add parentheses around Month, in its product with Wind
# [NOTA: this is a complex example just to illustrate how to use a regex with coef.sub]
etable(est1, est2, coef.sub = "x M(.+)$ => x (M\\1)")
#
# signif.code
#
etable(est1, est2, signif.code = c(" A"=0.01, " B"=0.05, " C"=0.1, " D"=0.15, " F"=1))
#
# Using the argument style to customize Latex exports
#
# If you don't like the default layout of the table, no worries!
# You can modify many parameters with the argument style
# To drop the headers before each section, use:
# Note that a space adds an extra line
style_noHeaders = style.tex(var.title = "", fixef.title = "", stats.title = " ")
etable(est1, est2, dict = dict, tex = TRUE, style.tex = style_noHeaders)
# To change the lines of the table + dropping the table footer
style_lines = style.tex(line.top = "\\toprule", line.bottom = "\\bottomrule",
tablefoot = FALSE)
etable(est1, est2, dict = dict, tex = TRUE, style.tex = style_lines)
# Or you have the predefined type "aer"
etable(est1, est2, dict = dict, tex = TRUE, style.tex = style.tex("aer"))
#
# Group and extralines
#
# Sometimes it's useful to group control variables into a single line
# You can achieve that with the group argument
setFixest_fml(..ctrl = ~ poly(Wind, 2) + poly(Temp, 2))
est_c0 = feols(Ozone ~ Solar.R, data = airquality)
est_c1 = feols(Ozone ~ Solar.R + ..ctrl, data = airquality)
est_c2 = feols(Ozone ~ Solar.R + Solar.R^2 + ..ctrl, data = airquality)
etable(est_c0, est_c1, est_c2, group = list(Controls = "poly"))
# 'group' here does the same as drop = "poly", but adds an extra line
# with TRUE/FALSE where the variables were found
# 'extralines' adds an extra line, where you can add the value for each model
est_all = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality)
est_sub1 = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality,
subset = ~ Month %in% 5:6)
est_sub2 = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality,
subset = ~ Month %in% 7:8)
est_sub3 = feols(Ozone ~ Solar.R + Temp + Wind, data = airquality,
subset = ~ Month == 9)
etable(est_all, est_sub1, est_sub2, est_sub3,
extralines = list("Sub-sample" = c("All", "May-June", "Jul.-Aug.", "Sept.")))
# You can monitor the placement of the new lines with two special characters
# at the beginning of the row name.
# 1) "^", "-" or "_" which mean the coefficients, the fixed-effects or the
# statistics section.
# 2) "^" or "_" which mean first or last line of the section
#
# Ex: starting with "_^" will place the line at the top of the stat. section
# starting with "-_" will place the line at the bottom of the FEs section
# etc.
#
# You can use a single character which will represent the section,
# the line would then appear at the bottom of the section.
# Examples
etable(est_c0, est_c1, est_c2, group = list("_Controls" = "poly"))
etable(est_all, est_sub1, est_sub2, est_sub3,
extralines = list("^^Sub-sample" = c("All", "May-June", "Jul.-Aug.", "Sept.")))
#
# headers
#
# You can add header lines with 'headers'
# These lines will appear at the top of the table
# first, 3 estimations
est_header = feols(c(Ozone, Solar.R, Wind) ~ poly(Temp, 2), airquality)
# header => vector: adds a line w/t title
etable(est_header, headers = c("A", "A", "B"))
# header => list: identical way to do the previous header
# The form is: list(item1 = #item1, item2 = #item2, etc)
etable(est_header, headers = list("A" = 2, "B" = 1))
# Adding a title +
# when an element is to be repeated only once, you can avoid the "= 1":
etable(est_header, headers = list(Group = list("A" = 2, "B")))
# To change the placement, add as first character:
# - "^" => top
# - "-" => mid (default)
# - "_" => bottom
# Note that "mid" and "top" are only distinguished when tex = TRUE
# Placing the new header line at the bottom
etable(est_header, headers = list("_Group" = c("A", "A", "B"),
"^Currency" = list("US $" = 2, "CA $" = 1)))
# In Latex, you can add "grouped underlines" (cmidrule from the booktabs package)
# by adding ":_:" in the title:
etable(est_header, tex = TRUE,
headers = list("^:_:Group" = c("A", "A", "B")))
#
# extralines and headers: .() for list()
#
# In the two arguments extralines and headers, .() can be used for list()
# For example:
etable(est_header, headers = .("^Currency" = .("US $" = 2, "CA $" = 1)))
#
# fixef.group
#
# You can group the fixed-effects line with fixef.group
est_0fe = feols(Ozone ~ Solar.R + Temp + Wind, airquality)
est_1fe = feols(Ozone ~ Solar.R + Temp + Wind | Month, airquality)
est_2fe = feols(Ozone ~ Solar.R + Temp + Wind | Month + Day, airquality)
# A) automatic way => simply use fixef.group = TRUE
etable(est_0fe, est_2fe, fixef.group = TRUE)
# Note that when grouping would lead to inconsistencies across models,
# it is avoided
etable(est_0fe, est_1fe, est_2fe, fixef.group = TRUE)
# B) customized way => use a list
etable(est_0fe, est_2fe, fixef.group = list("Dates" = "Month|Day"))
# Note that when a user grouping would lead to inconsistencies,
# the term partial replaces yes/no and the fixed-effects are not removed.
etable(est_0fe, est_1fe, est_2fe, fixef.group = list("Dates" = "Month|Day"))
# Using customized placement => as with 'group' and 'extralines',
# the user can control the placement of the new line.
# See the previous 'group' examples and the dedicated section in the help.
# On top of the coefficients:
etable(est_0fe, est_2fe, fixef.group = list("^^Dates" = "Month|Day"))
# Last line of the statistics
etable(est_0fe, est_2fe, fixef.group = list("_Dates" = "Month|Day"))
#
# Using custom functions to compute the standard errors
#
# You can use external functions to compute the VCOVs
# by feeding functions in the 'vcov' argument.
# Let's use some covariances from the sandwich package
etable(est_c0, est_c1, est_c2, vcov = sandwich::vcovHC)
# To add extra arguments to vcovHC, you need to write your wrapper:
etable(est_c0, est_c1, est_c2, vcov = function(x) sandwich::vcovHC(x, type = "HC0"))
#
# Customize which fit statistic to display
#
# You can change the fit statistics with the argument fitstat
# and you can rename them with the dictionary
etable(est1, est2, fitstat = ~ r2 + n + G)
# If you use a formula, '.' means the default:
etable(est1, est2, fitstat = ~ ll + .)
#
# Computing a different SE for each model
#
est = feols(Ozone ~ Solar.R + Wind + Temp, data = airquality)
#
# Method 1: use summary
s1 = summary(est, "iid")
s2 = summary(est, cluster = ~ Month)
s3 = summary(est, cluster = ~ Day)
s4 = summary(est, cluster = ~ Day + Month)
etable(list(s1, s2, s3, s4))
#
# Method 2: using a list in the argument 'vcov'
est_bis = feols(Ozone ~ Solar.R + Wind + Temp | Month, data = airquality)
etable(est, est_bis, vcov = list("hetero", ~ Month))
# When you have only one model, this model is replicated
# along the elements of the vcov list.
etable(est, vcov = list("hetero", ~ Month))
#
# Method 3: Using "each" or "times" in vcov
# If the first element of the list in 'vcov' is "each" or "times",
# then all models will be replicated and all the VCOVs will be
# applied to each model. The order in which they are replicated
# are governed by the each/times keywords.
# each
etable(est, est_bis, vcov = list("each", "iid", ~ Month, ~ Day))
# times
etable(est, est_bis, vcov = list("times", "iid", ~ Month, ~ Day))
#
# Notes and markup
#
# Notes can be also be set in a dictionary
# You can use markdown markup to put text into italic/bold
dict = c("note 1" = "*Notes:* This data is not really random.",
"source 1" = "**Source:** the internet?")
est = feols(Ozone ~ csw(Solar.R, Wind, Temp), data = airquality)
etable(est, dict = dict, tex = TRUE, notes = c("note 1", "source 1"))
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.