REPRO-Bench / 17 /replication_package /code /lib /stata /ado /iebaltab_edit.ado
anonymous-submission-acl2025's picture
add 17
8a79f2e
raw
history blame
99.1 kB
// EDIT:
// - Change functionality of option `onenrow`
// - Now takes max number of observations instead of throwing error
// when number of observations different aross variables
*! version 6.3 5NOV2019 DIME Analytics dimeanalytics@worldbank.org
capture program drop iebaltab_edit
program iebaltab_edit
syntax varlist(numeric) [if] [in] [aw fw pw iw], ///
///
/*Group variable*/ ///
GRPVar(varname) ///
///
[ ///
/*Columns and order of columns*/ ///
ORder(numlist int min=1) ///
COntrol(numlist int max=1) ///
TOTal ///
///
/*Column and row labels*/ ///
GRPCodes ///
GRPLabels(string) ///
TOTALLabel(string) ///
ROWVarlabels ///
ROWLabels(string) ///
onerow ///
onenrow ///
///
/*Statistics and data manipulation*/ ///
FIXedeffect(varname) ///
COVariates(varlist ts fv) ///
COVARMISSOK ///
vce(string) ///
BALMISS(string) ///
BALMISSReg(string) ///
COVMISS(string) ///
COVMISSReg(string) ///
MISSMINmean(numlist min=1 max=1 >0) ///
WEIGHTold(string) ///
///
/*F-test*/ ///
FTest ///
FMissok ///
FNOOBS ///
///
/*Output display*/ ///
NOTtest ///
NORMDiff ///
PTtest ///
PFtest ///
FEQTest ///
PBoth ///
STDev ///
STARlevels(numlist descending min=3 max=3 >0 <1) ///
STARSNOadd ///
FORMat(string) ///
TBLNote(string) ///
NOTECombine ///
TBLNONote ///
///
/*Export and restore*/ ///
SAVE(string) ///
SAVETex(string) ///
TEXNotewidth(numlist min=1 max=1) ///
TEXCaption(string) ///
TEXLabel(string) ///
TEXDOCument ///
texvspace(string) ///
texcolwidth(string) ///
BROWSE ///
SAVEBRowse ///
REPLACE ///
]
********POTENTIAL UPDATES*********
*1. Implement option for bootstrap
********HELPFILE TODO*********
*1. Explain difference in se between group by itself and the standard errors used in the t-test
preserve
qui {
*Set minimum version for this command
version 11
* Backwards compatibility for weight option
if "`weightold'" != "" & "`exp'" == "" {
tokenize `weightold', parse(=)
local weight "`1'"
local exp = "= `3'"
}
*Remove observations excluded by if and in
marksample touse, novarlist
keep if `touse'
if 1 {
/***********************************************
************************************************
Set initial constants
*************************************************
************************************************/
*Create local for balance vars with more descriptive name
local balancevars `varlist'
** Column Options
*Is option control() used:
if "`control'" == "" local CONTROL_USED = 0
if "`control'" != "" local CONTROL_USED = 1
*Is option order() used:
if "`order'" == "" local ORDER_USED = 0
if "`order'" != "" local ORDER_USED = 1
*Is option grpcodes used:
if "`grpcodes'" == "" local NOGRPLABEL_USED = 0
if "`grpcodes'" != "" local NOGRPLABEL_USED = 1
*Is option nolabel used:
if "`grplabels'" == "" local GRPLABEL_USED = 0
if "`grplabels'" != "" local GRPLABEL_USED = 1
*Is option total() used:
if "`total'" == "" local TOTAL_USED = 0
if "`total'" != "" local TOTAL_USED = 1
*Is option totallable() used:
if "`totallabel'" == "" local TOTALLABEL_USED = 0
if "`totallabel'" != "" local TOTALLABEL_USED = 1
** Row Options
*Is option total() used:
if "`rowvarlabels'" == "" local ROWVARLABEL_USED = 0
if "`rowvarlabels'" != "" local ROWVARLABEL_USED = 1
*Is option totallable() used:
if "`rowlabels'" == "" local ROWLABEL_USED = 0
if "`rowlabels'" != "" local ROWLABEL_USED = 1
*Is option totallable() used:
if "`onenrow'" != "" local onerow = "onerow" //Old name still supported for backward compatibility
if "`onerow'" == "" local ONEROW_USED = 0
if "`onerow'" != "" local ONEROW_USED = 1
** Stats Options
*Is option ftest used:
if "`ftest'" == "" local FTEST_USED = 0
if "`ftest'" != "" local FTEST_USED = 1
*Is option fmiss used:
if "`fmissok'" == "" local F_MISS_OK = 0
if "`fmissok'" != "" local F_MISS_OK = 1
*Is option fnoobs used:
if "`fnoobs'" == "" local F_NO_OBS = 0
if "`fnoobs'" != "" local F_NO_OBS = 1
*Is option fixedeffect() used:
if "`fixedeffect'" == "" local FIX_EFFECT_USED = 0
if "`fixedeffect'" != "" local FIX_EFFECT_USED = 1
*Is option covariates() used:
if "`covariates'" == "" local COVARIATES_USED = 0
if "`covariates'" != "" local COVARIATES_USED = 1
*Is option covarmissok used:
if "`covarmissok'" == "" local COVARMISSOK_USED = 0
if "`covarmissok'" != "" local COVARMISSOK_USED = 1
*Is option cluster() used:
if "`vce'" == "" local VCE_USED = 0
if "`vce'" != "" local VCE_USED = 1
*Is option balmiss() used:
if "`balmiss'" == "" local BALMISS_USED = 0
if "`balmiss'" != "" local BALMISS_USED = 1
*Is option missreg() used:
if "`balmissreg'" == "" local BALMISSREG_USED = 0
if "`balmissreg'" != "" local BALMISSREG_USED = 1
*Is option covmiss() used:
if "`covmiss'" == "" local COVMISS_USED = 0
if "`covmiss'" != "" local COVMISS_USED = 1
*Is option covmissreg() used:
if "`covmissreg'" == "" local COVMISSREG_USED = 0
if "`covmissreg'" != "" local COVMISSREG_USED = 1
*Is option missminmean() used:
if "`missminmean'" == "" local MISSMINMEAN_USED = 0
if "`missminmean'" != "" local MISSMINMEAN_USED = 1
*Is option starlevels() used:
if "`starlevels'" == "" local STARLEVEL_USED = 0
if "`starlevels'" != "" local STARLEVEL_USED = 1
*Is option starsnoadd used:
if "`starsnoadd'" == "" local STARSNOADD_USED = 0
if "`starsnoadd'" != "" local STARSNOADD_USED = 1
*Is option nottest used:
if "`nottest'" == "" local TTEST_USED = 1
if "`nottest'" != "" local TTEST_USED = 0
*Is option pttest() used:
if "`pttest'" == "" local PTTEST_USED = 0
if "`pttest'" != "" local PTTEST_USED = 1
*Is option pftest() used:
if "`pftest'" == "" local PFTEST_USED = 0
if "`pftest'" != "" local PFTEST_USED = 1
*Is option pboth() used:
if "`pboth'" == "" local PBOTH_USED = 0
if "`pboth'" != "" local PBOTH_USED = 1
if `PBOTH_USED' == 1 local PTTEST_USED = 1
if `PBOTH_USED' == 1 local PFTEST_USED = 1
*Is option pftest() used:
if "`stdev'" == "" local STDEV_USED = 0
if "`stdev'" != "" local STDEV_USED = 1
*Is option weight() used:
if "`weight'" == "" local WEIGHT_USED = 0
if "`weight'" != "" local WEIGHT_USED = 1
*Is option feqtest() user:
if "`feqtest'" == "" local FEQTEST_USED = 0
if "`feqtest'" != "" local FEQTEST_USED = 1
*Is option normdiff() used:
if "`normdiff'" == "" local NORMDIFF_USED = 0
if "`normdiff'" != "" local NORMDIFF_USED = 1
** Output Options
*Is option format() used:
if "`format'" == "" local FORMAT_USED = 0
if "`format'" != "" local FORMAT_USED = 1
*Is option save() used:
if "`save'" == "" local SAVE_USED = 0
if "`save'" != "" local SAVE_USED = 1
*Is option savetex() used:
if "`savetex'" == "" local SAVE_TEX_USED = 0
if "`savetex'" != "" local SAVE_TEX_USED = 1
*Is option texnotewidth() used:
if "`texnotewidth'" == "" local NOTEWIDTH_USED = 0
if "`texnotewidth'" != "" local NOTEWIDTH_USED = 1
*Is option texnotewidth() used:
if "`texcaption'" == "" local CAPTION_USED = 0
if "`texcaption'" != "" local CAPTION_USED = 1
*Is option texnotewidth() used:
if "`texlabel'" == "" local LABEL_USED = 0
if "`texlabel'" != "" local LABEL_USED = 1
*Is option texdocument() used:
if "`texdocument'" == "" local TEXDOC_USED = 0
if "`texdocument'" != "" local TEXDOC_USED = 1
*Is option texlinespace() used:
if "`texvspace'" == "" local TEXVSPACE_USED = 0
if "`texvspace'" != "" local TEXVSPACE_USED = 1
*Is option texcolwidth() used:
if "`texcolwidth'" == "" local TEXCOLWIDTH_USED = 0
if "`texcolwidth'" != "" local TEXCOLWIDTH_USED = 1
*Is option browse() used:
if "`browse'" == "" local BROWSE_USED = 0
if "`browse'" != "" local BROWSE_USED = 1
*Is option restore() used:
if "`savebrowse'" == "" local SAVE_BROWSE_USED = 0
if "`savebrowse'" != "" local SAVE_BROWSE_USED = 1
*Is option restore() used:
if "`replace'" == "" local REPLACE_USED = 0
if "`replace'" != "" local REPLACE_USED = 1
*Is option tablenote() used:
if "`tblnote'" == "" local NOTE_USED = 0
if "`tblnote'" != "" local NOTE_USED = 1
*Is option notecombine() used:
if "`notecombine'" == "" local NOTECOMBINE_USED = 0
if "`notecombine'" != "" local NOTECOMBINE_USED = 1
*Is option notablenote() used:
if "`tblnonote'" == "" local NONOTE_USED = 0
if "`tblnonote'" != "" local NONOTE_USED = 1
/***********************************************
************************************************
Prepare a list of group variables
*************************************************
************************************************/
cap confirm numeric variable `grpvar'
if _rc != 0 {
*Test for commands not allowed if grpvar is a string variable
if `CONTROL_USED' == 1 {
di as error "{pstd}The option control() can only be used if variable {it:`grpvar'} is a numeric variable. Use {help encode} to generate a numeric version of variable {it:`grpvar'}. It is best practice to store all categorical variables as labeled numeric variables.{p_end}"
error 198
}
if `ORDER_USED' == 1 {
di as error "{pstd}The option order() can only be used if variable {it:`grpvar'} is a numeric variable. Use {help encode} to generate a numeric version of variable {it:`grpvar'}. It is best practice to store all categorical variables as labeled numeric variables.{p_end}"
error 198
}
if `NOGRPLABEL_USED' == 1 {
di as error "{pstd}The option grpcodes can only be used if variable {it:`grpvar'} is a numeric variable. Use {help encode} to generate a numeric version of variable {it:`grpvar'}. It is best practice to store all categorical variables as labeled numeric variables.{p_end}"
error 198
}
if `GRPLABEL_USED' == 1 {
di as error "{pstd}The option grplabels() can only be used if variable {it:`grpvar'} is a numeric variable. Use {help encode} to generate a numeric version of variable {it:`grpvar'}. It is best practice to store all categorical variables as labeled numeric variables.{p_end}"
error 198
}
*Generate a encoded tempvar version of grpvar
tempvar grpvar_code
encode `grpvar' , gen(`grpvar_code')
*replace the grpvar local so that it uses the tempvar instead
local grpvar `grpvar_code'
}
*Remove observations with a missing value in grpvar()
drop if `grpvar' >= .
*Create a local of all codes in group variable
levelsof `grpvar', local(GRP_CODE_LEVELS)
*Saving the name of the value label of the grpvar()
local GRPVAR_VALUE_LABEL : value label `grpvar'
*Counting how many levels there are in groupvar
local GRPVAR_NUM_GROUPS : word count `GRP_CODE_LEVELS'
*Static dummy for grpvar() has no label
if "`GRPVAR_VALUE_LABEL'" == "" local GRPVAR_HAS_VALUE_LABEL = 0
if "`GRPVAR_VALUE_LABEL'" != "" local GRPVAR_HAS_VALUE_LABEL = 1
*Number of columns for Latex
local NUM_COL_GRP_TOT = `GRPVAR_NUM_GROUPS' + `TOTAL_USED'
/***********************************************
************************************************/
*Testing that options to iebaltab is correctly specified and make initial operations based on these commands
/*************************************************
************************************************/
** Group Options
cap confirm numeric variable `grpvar'
if _rc != 0 {
noi display as error "{phang}The variable listed in grpvar(`grpvar') is not a numeric variable. See {help encode} for options on how to make a categorical string variable into a categorical numeric variable{p_end}"
error 108
}
else {
** Testing that groupvar is a categorical variable. Int() rounds to
* integer, and if any values are non-integers then (int(`grpvar') == `grpvar) is
* not true
cap assert ( int(`grpvar') == `grpvar' )
if _rc == 9 {
noi display as error "{phang}The variable in grpvar(`grpvar') is not a categorical variable. The variable may only include integers where each integer indicates which group each observation belongs to. See tabulation of `grpvar' below:{p_end}"
noi tab `grpvar', nol
error 109
}
}
** Column Options
** If control() or order() is used, then the levels specified in those
* options need to exist in the groupvar
local control_correct : list control in GRP_CODE_LEVELS
if `control_correct' == 0 {
noi display as error "{phang}The code listed in control(`control') is not used in grpvar(`grpvar'). See tabulation of `grpvar' below:"
noi tab `grpvar', nol
error 197
}
local order_correct : list order in GRP_CODE_LEVELS
if `order_correct' == 0 {
noi display as error "{phang}One or more codes listed in order(`order') are not used in grpvar(`grpvar'). See tabulation of `grpvar' below:"
noi tab `grpvar', nol
error 197
}
if `GRPLABEL_USED' == 1 {
local col_labels_to_tokenize `grplabels'
while "`col_labels_to_tokenize'" != "" {
*Parsing code and label pair
gettoken codeAndLabel col_labels_to_tokenize : col_labels_to_tokenize, parse("@")
*Splitting code and label
gettoken code label : codeAndLabel
*** Codes
*Checking that code exist in grpvar and store it
local code_correct : list code in GRP_CODE_LEVELS
if `code_correct' == 0 {
noi display as error "{phang}Code [`code'] listed in grplabels(`grplabels') is not used in grpvar(`grpvar'). See tabulation of `grpvar' below:"
noi tab `grpvar', nol
error 198
}
*Storing the code in local to be used later
local grpLabelCodes `"`grpLabelCodes' "`code'" "'
*** Labels
*Removing leadning or trailing spaces
local label = trim("`label'")
*Testing that no label is missing
if "`label'" == "" {
noi display as error "{phang}For code [`code'] listed in grplabels(`grplabels') you have not specified any label. Labels are requried for all codes listed in grplabels(). See tabulation of `grpvar' below:"
noi tab `grpvar', nol
error 198
}
*Storing the label in local to be used later
local grpLabelLables `"`grpLabelLables' "`label'" "'
*Parse char is not removed by gettoken
local col_labels_to_tokenize = subinstr("`col_labels_to_tokenize'" ,"@","",1)
}
}
if `ROWLABEL_USED' {
*** Test the validity for the rowlabel input
*Create a local with the rowlabel input to be tokenized
local row_labels_to_tokenize `rowlabels'
while "`row_labels_to_tokenize'" != "" {
*Parsing name and label pair
gettoken nameAndLabel row_labels_to_tokenize : row_labels_to_tokenize, parse("@")
*Splitting name and label
gettoken name label : nameAndLabel
*** Variable names
*Checking that the variables used in rowlabels() are included in the table
local name_correct : list name in balancevars
if `name_correct' == 0 {
noi display as error "{phang}Variable [`name'] listed in rowlabels(`rowlabels') is not found among the variables included in the balance table."
error 111
}
*Storing the code in local to be used later
local rowLabelNames `"`rowLabelNames' "`name'" "'
*** Variable labels
*Removing leading or trailing spaces
local label = trim("`label'")
*Testing that no label is missing
if "`label'" == "" {
noi display as error "{phang}For variable [`name'] listed in rowlabels(`rowlabels') you have not specified any label. Labels are requried for all variables listed in rowlabels(). The variable name itself will be used for any variables omitted from rowlabels(). See also option {help iebaltab:rowvarlabels}"
noi tab `grpvar', nol
error 198
}
*Storing the label in local to be used later
local rowLabelLabels `"`rowLabelLabels' "`label'" "'
*Parse char is not removed by gettoken
local row_labels_to_tokenize = subinstr("`row_labels_to_tokenize'" ,"@","",1)
}
}
if `TOTALLABEL_USED' & !`TOTAL_USED' {
*Error for totallabel() incorrectly applied
noi display as error "{phang}Option totallabel() may only be used together with the option total"
error 197
}
** Stats Options
local SHOW_NCLUSTER 0
if `VCE_USED' == 1 {
local vce_nocomma = subinstr("`vce'", "," , " ", 1)
tokenize "`vce_nocomma'"
local vce_type `1'
if "`vce_type'" == "robust" {
*Robust is allowed and not other tests needed
}
else if "`vce_type'" == "cluster" {
*Create a local for displaying number of clusters
local SHOW_NCLUSTER 1
local cluster_var `2'
cap confirm variable `cluster_var'
if _rc {
*Error for vce(cluster) incorrectly applied
noi display as error "{phang}The cluster variable in vce(`vce') does not exist or is invalid for any other reason. See {help vce_option :help vce_option} for more information. "
error _rc
}
}
else if "`vce_type'" == "bootstrap" {
*bootstrap is allowed and not other tests needed. Error checking is more comlex, add tests here in the future.
}
else {
*Error for vce() incorrectly applied
noi display as error "{phang}The vce type `vce_type' in vce(`vce') is not allowed. Only robust, cluster and bootstrap are allowed. See {help vce_option :help vce_option} for more information."
error 198
}
}
if `STARSNOADD_USED' == 0 {
*Allow user defined p-values for stars or set the default values
if `STARLEVEL_USED' == 1 {
*Tokenize the string with the p-values entered by the user. The value entered are tested in syntax
tokenize "`starlevels'"
*Set user defined levels for 1, 2 and 3 stars
local p1star `1'
local p2star `2'
local p3star `3'
}
else {
*Set default levels for 1, 2 and 3 stars
local p1star .1
local p2star .05
local p3star .01
}
** Create locals with the values expressed
* as percentages for the note to the table
local p1star_percent = `p1star' * 100
local p2star_percent = `p2star' * 100
local p3star_percent = `p3star' * 100
}
else {
*Options starsomitt is used. No stars will be displayed. By setting
*these locals to nothing the loop adding stars will not be iterated
local p1star
local p2star
local p3star
}
*Error for starlevels incorrectly used together with starsnoadd
if `STARSNOADD_USED' & `STARLEVEL_USED' {
*Error for starlevels and starsnoadd incorrectly used together
noi display as error "{phang}Option starlevels() may not be used in combination with option starsnoadd"
error 197
}
*Error for miss incorrectly used together with missreg
if `BALMISS_USED' & `BALMISSREG_USED' {
*Error for balmiss and balmissreg incorrectly used together
noi display as error "{phang}Option balmiss() may not be used in combination with option balmissreg()"
error 197
}
if `COVMISS_USED' & `COVMISSREG_USED' {
*Error for covmiss and covmissreg incorrectly used together
noi display as error "{phang}Option covmiss() may not be used in combination with option covmissreg()"
error 197
}
if !`TTEST_USED' {
if `PTTEST_USED' {
*Error for nottest and pttest incorrectly used together
noi display as error "{phang}Option pttest may not be used in combination with option nottest"
error 197
}
if `PBOTH_USED' {
*Error for nottest and pboth incorrectly used together
noi display as error "{phang}Option pboth may not be used in combination with option nottest"
error 197
}
}
if `FTEST_USED' & !`TTEST_USED' & !`NORMDIFF_USED' {
*Error for F-test used, but not t-test of normalized difference:
*no columns are created for F-test to be displayed
noi di as error "{phang}Option ftest may not only be used if either t-tests or normalized differences are used. F-test for joing significance of balance variables will not be displayed. In order to display it, either use option normdiff or remove option nottest.{p_end}"
local FTEST_USED = 0
}
*Testing input in these for options. See function at the end of this command
if `BALMISS_USED' == 1 iereplacestringtest "balmiss" "`balmiss'"
if `BALMISSREG_USED' == 1 iereplacestringtest "balmissreg" "`balmissreg'"
if `COVMISS_USED' == 1 iereplacestringtest "covmiss" "`covmiss'"
if `COVMISSREG_USED' == 1 iereplacestringtest "covmissreg" "`covmissreg'"
if `FIX_EFFECT_USED' == 1 {
cap assert `fixedeffect' < .
if _rc == 9 {
noi display as error "{phang}The variable in fixedeffect(`fixedeffect') is missing for some observations. This would cause observations to be dropped in the estimation regressions. See tabulation of `fixedeffect' below:{p_end}"
noi tab `fixedeffect', m
error 109
}
}
* test covariate variables
if `COVARIATES_USED' == 1 {
foreach covar of local covariates {
*Create option string
local replaceoptions
*Sopecify differently based on all missing or only regualr missing
if `COVMISS_USED' local replaceoptions `" `replaceoptions' replacetype("`covmiss'") "'
if `COVMISSREG_USED' local replaceoptions `" `replaceoptions' replacetype("`covmissreg'") regonly "'
*Add group variable if the replace type is group mean
if "`covmiss'" == "groupmean" local replaceoptions `" `replaceoptions' groupvar(`grpvar') groupcodes("`GRP_CODE_LEVELS'") "'
if "`covmissreg'" == "groupmean" local replaceoptions `" `replaceoptions' groupvar(`grpvar') groupcodes("`GRP_CODE_LEVELS'") "'
*Set the minimum number of observations to allow means to be set from
if `MISSMINMEAN_USED' == 1 local replaceoptions `" `replaceoptions' minobsmean(`missminmean') "'
if `MISSMINMEAN_USED' == 0 local replaceoptions `" `replaceoptions' minobsmean(10) "'
*Excute the command. Code is found at the bottom of this ado file
if (`COVMISS_USED' | `COVMISSREG_USED') iereplacemiss `covariates', `replaceoptions'
if `COVARMISSOK_USED' != 1 {
cap assert `covar' < .
if _rc == 9 {
noi display as error "{phang}The variable `covar' specified in covariates() has missing values for one or more observations. This would cause observations to be dropped in the estimation regressions. To allow for observations to be dropped see option covarmissok and to make the command treat missing values as zero see option covmiss() and covmissreg(). Click {stata tab `covar' `if' `in', m} to see the missing values.{p_end}"
error 109
}
}
}
}
if `WEIGHT_USED' == 1 {
* Parsing weight options
local weight_type = "`weight'"
* Parsing keeps the separating character
local weight_var = subinstr("`exp'","=","",.)
* Test is weight type specified is valie
local weight_options "fweights pweights aweights iweights fweight pweight aweight iweight fw freq weight pw aw iw"
if `:list weight_type in weight_options' == 0 {
noi display as error "{phang} The option `weight_type' specified in weight() is not a valid weight option. Weight options are: fweights, fw, freq, weight, pweights, pw, aweights, aw, iweights, and iw. {p_end}"
error 198
}
* Test is weight variable specified if valid
capture confirm variable `weight_var'
if _rc {
noi display as error "{phang} The option `weight_var' specified in weight() is not a variable. {p_end}"
error 198
}
}
** Output Options
** If the format option is specified, then test if there is a valid format specified
if `FORMAT_USED' == 1 {
** Creating a numeric mock variable that we attempt to apply the format
* to. This allows us to piggy back on Stata's internal testing to be
* sure that the format specified is at least one of the valid numeric
* formats in Stata
tempvar formattest
gen `formattest' = 1
cap format `formattest' `format'
if _rc == 120 {
di as error "{phang}The format specified in format(`format') is not a valid Stata format. See {help format} for a list of valid Stata formats. This command only accept the f, fc, g, gc and e format.{p_end}"
error 120
}
else if _rc != 0 {
di as error "{phang}Something unexpected happened related to the option format(`format'). Make sure that the format you specified is a valid format. See {help format} for a list of valid Stata formats. If this problem remains, please report this error to kbjarkefur@worldbank.org.{p_end}"
error _rc
}
else {
** We know here that the format is one of the numeric formats that Stata allows
local fomrmatAllowed 0
local charLast = substr("`format'", -1,.)
local char2Last = substr("`format'", -2,.)
if "`charLast'" == "f" | "`charLast'" == "e" {
local fomrmatAllowed 1
}
else if "`charLast'" == "g" {
if "`char2Last'" == "tg" {
*format tg not allowed. all other valid formats ending on g are allowed
local fomrmatAllowed 0
}
else {
*Formats that end in g that is not tg can only be g which is allowed.
local fomrmatAllowed 1
}
}
else if "`charLast'" == "c" {
if "`char2Last'" != "gc" & "`char2Last'" != "fc" {
*format ends on c but is neither fc nor gc
local fomrmatAllowed 0
}
else {
*Formats that end in c that are either fc or gc are allowed.
local fomrmatAllowed 1
}
}
else {
*format is neither f, fc, g, gc nor e
local fomrmatAllowed 0
}
if `fomrmatAllowed' == 0 {
di as error "{phang}The format specified in format(`format') is not allowed. Only format f, fc, g, gc and e are allowed. See {help format} for details on Stata formats.{p_end}"
error 120
}
*If format passed all tests, store it in the local used for display formats
local diformat = "`format'"
}
}
else {
*Default value if fomramt not specified
local diformat = "%9.3f"
}
*Error for tblnonote incorrectly used together with notecombine
if `NOTECOMBINE_USED' & `NONOTE_USED' {
*Error for tblnonote incorrectly used together with notecombine
noi display as error "{phang}Option tblnonote may not be used in combination with option notecombine"
error 197
}
if `SAVE_USED' | `SAVE_TEX_USED' {
if `SAVE_USED' {
**Find the last . in the file path and assume that
* the file extension is what follows. If a file path has a . then
* the file extension must be explicitly specified by the user.
*Copy the full file path to the file suffix local
local file_suffix = "`save'"
** Find index for where the file type suffix start
local dot_index = strpos("`file_suffix'",".")
*If no dot then no file extension
if `dot_index' == 0 local file_suffix ""
**If there is one or many . in the file path than loop over
* the file path until we have found the last one.
while `dot_index' > 0 {
*Extract the file index
local file_suffix = substr("`file_suffix'", `dot_index' + 1, .)
*Find index for where the file type suffix start
local dot_index = strpos("`file_suffix'",".")
}
*If no file format suffix is specified, use the default .xlsx
if "`file_suffix'" == "" {
local save `"`save'.xlsx"'
}
*If a file format suffix is specified make sure that it is one of the two allowed.
else if !("`file_suffix'" == "xls" | "`file_suffix'" == "xlsx") {
noi display as error "{phang}The file format specified in save(`save') is other than .xls or .xlsx. Only those two formats are allowed. If no format is specified .xlsx is the default. If you have a . in your file path, for example in a folder name, then you must specify the file extension .xls or .xlsx.{p_end}"
error 198
}
}
if `SAVE_TEX_USED' {
**Find the last . in the file path and assume that
* the file extension is what follows. If a file path has a . then
* the file extension must be explicitly specified by the user.
*Copy the full file path to the file suffix local
local tex_file_suffix = "`savetex'"
** Find index for where the file type suffix start
local tex_dot_index = strpos("`tex_file_suffix'",".")
*If no dot then no file extension
if `tex_dot_index' == 0 local tex_file_suffix ""
**If there is one or many . in the file path than loop over
* the file path until we have found the last one.
while `tex_dot_index' > 0 {
*Extract the file index
local tex_file_suffix = substr("`tex_file_suffix'", `tex_dot_index' + 1, .)
*Find index for where the file type suffix start
local tex_dot_index = strpos("`tex_file_suffix'",".")
}
*If no file format suffix is specified, use the default .tex
if "`tex_file_suffix'" == "" {
local savetex `"`savetex'.tex"'
}
*If a file format suffix is specified make sure that it is one of the two allowed.
else if !("`tex_file_suffix'" == "tex" | "`tex_file_suffix'" == "txt") {
noi display as error "{phang}The file format specified in savetex(`savetex') is other than .tex or .txt. Only those two formats are allowed. If no format is specified .tex is the default. If you have a . in your file path, for example in a folder name, then you must specify the file extension .tex or .txt.{p_end}"
error 198
}
if `CAPTION_USED' {
* Make sure special characters are displayed correctly
local texcaption : subinstr local texcaption "%" "\%" , all
local texcaption : subinstr local texcaption "_" "\_" , all
local texcaption : subinstr local texcaption "&" "\&" , all
}
}
}
else if `SAVE_BROWSE_USED' {
noi display as error "{phang}Option savepreserve may only be used in combination with option save(){p_end}"
error 198
}
* Check tex options
if `SAVE_TEX_USED' {
* Note width must be positive
if `NOTEWIDTH_USED' {
if `texnotewidth' <= 0 {
noi display as error `"{phang}The value specified in texnotewidth(`texnotewidth') is non-positive. Only positive numbers are allowed. For more information, {net "from http://en.wikibooks.org/wiki/LaTeX/Lengths.smcl":check LaTeX lengths manual}.{p_end}"'
error 198
}
}
* Tex label must be a single word
if `LABEL_USED' {
local label_words : word count `texlabel'
if `label_words' != 1 {
noi display as error `"{phang}The value specified in texlabel(`texlabel') is not allowed. For more information, {browse "https://en.wikibooks.org/wiki/LaTeX/Labels_and_Cross-referencing":check LaTeX labels manual}.{p_end}"'
error 198
}
}
if (`LABEL_USED' | `CAPTION_USED') {
if `TEXDOC_USED' == 0 {
noi display as error "{phang}Options texlabel and texcaption may only be used in combination with option texdocument {p_end}"
error 198
}
}
if `TEXCOLWIDTH_USED' {
* Test if width unit is correctly specified
local texcolwidth_unit = substr("`texcolwidth'",-2,2)
if !inlist("`texcolwidth_unit'","cm","mm","pt","in","ex","em") {
noi display as error `"{phang}Option texcolwidth is incorrectly specified. Column width unit must be one of "cm", "mm", "pt", "in", "ex" or "em". For more information, {browse "https://en.wikibooks.org/wiki/LaTeX/Lengths":check LaTeX lengths manual}.{p_end}"'
error 198
}
* Test if width value is correctly specified
local texcolwidth_value = subinstr("`texcolwidth'","`texcolwidth_unit'","",.)
capture confirm number `texcolwidth_value'
if _rc & inlist("`texcolwidth_unit'","cm","mm","pt","in","ex","em") {
noi display as error "{phang}Option texcolwidth is incorrectly specified. Column width value must be numeric. See {help iebaltab:iebaltab help}. {p_end}"
error 198
}
}
if `TEXVSPACE_USED' {
* Test if width unit is correctly specified
local vspace_unit = substr("`texvspace'",-2,2)
if !inlist("`vspace_unit'","cm","mm","pt","in","ex","em") {
noi display as error `"{phang}Option texvspace is incorrectly specified. Vertical space unit must be one of "cm", "mm", "pt", "in", "ex" or "em". For more information, {browse "https://en.wikibooks.org/wiki/LaTeX/Lengths":check LaTeX lengths manual}.{p_end}"'
error 198
}
* Test if width value is correctly specified
local vspace_value = subinstr("`texvspace'","`vspace_unit'","",.)
capture confirm number `vspace_value'
if _rc & inlist("`vspace_unit'","cm","mm","pt","in","ex","em") {
noi display as error "{phang}Option texvspace is incorrectly specified. Vertical space value must be numeric. See {help iebaltab:iebaltab help}. {p_end}"
error 198
}
}
}
* Error for incorrectly using tex options
else if `NOTEWIDTH_USED' | `LABEL_USED' | `CAPTION_USED' | `TEXDOC_USED' | `TEXVSPACE_USED' | `TEXCOLWIDTH_USED' {
noi display as error "{phang}Options texnotewidth, texdocument, texlabel, texcaption, texvspace and texcolwidth may only be used in combination with option savetex(){p_end}"
error 198
}
*At least one of save and browse may be used
if (`SAVE_USED' + `BROWSE_USED' + `SAVE_TEX_USED' < 1) {
*Error for incorrectly using both save() and browse
noi display as error "{phang}Either option save() or option savetex() or option browse must be used. Note that option browse drops all data in memory and it is not possible to restore it afterwards. Use preserve/restore, tempfiles or save data to disk before using the otion browse."
error
}
/***********************************************
************************************************/
*Manage order in levels of grpvar()
/*************************************************
************************************************/
*Changed to value used in control() if control() is
*specified but order() is not,
if !`ORDER_USED' & `CONTROL_USED' local order `control'
*Unless changed above, either as specified in order().
*if order() is not specified then the all levels in
*numeric order is stored in order_code_rest to be.
local order_code_rest : list GRP_CODE_LEVELS - order
*The final order is compiled. order_code_rest
*is ordered numerically. If order has no yet
*been defined (if niether order() or control()
* was used) then order will be exactly like
* order_code_rest
local ORDER_OF_GROUPS `order' `order_code_rest'
/***********************************************
************************************************/
*Manage lables to be used for the groups in groupvar
/*************************************************
************************************************/
*Local that will store the final labels. These labels will be stored in the in final order of groups in groupvar
local grpLabels_final ""
*Loop over all groups in the final order
foreach groupCode of local ORDER_OF_GROUPS {
*Test if this code has a manually defined group label
local grpLabelPos : list posof "`groupCode'" in grpLabelCodes
*If index is not zero then manual label is defined, use it
if `grpLabelPos' != 0 {
*Getting the manually defined label corresponding to this code
local group_label : word `grpLabelPos' of `grpLabelLables'
*Storing the label to be used for this group code.
local grpLabels_final `" `grpLabels_final' "`group_label'" "'
}
** No manually defined label, test if group var has value labels or if user
* has specified that value labels should not be used
else if `NOGRPLABEL_USED' | !`GRPVAR_HAS_VALUE_LABEL' {
*Not using value labels, simply using the group code as the label in the final table
local grpLabels_final `" `grpLabels_final' "`groupCode'" "'
}
*No defined group label but value labels exist and may be used
else {
*Get the value label corresponding to this code
local gprVar_valueLabel : label `GRPVAR_VALUE_LABEL' `groupCode'
*Storing the value label used for grpvar corresponding to the group code.
local grpLabels_final `" `grpLabels_final' "`gprVar_valueLabel'" "'
}
}
/***********************************************
************************************************/
*Manage labels to be used as rowtitles
/*************************************************
************************************************/
local rowLabelsFinal ""
foreach balancevar of local balancevars {
** Test if this variable has a manually defined rowlable. If
* rowlabels() was not specified, then this local will be empty
* and generate index 0 for all variables
local rowLabPos : list posof "`balancevar'" in rowLabelNames
if `rowLabPos' != 0 {
*Getting the manually defined label corresponding to this code
local row_label : word `rowLabPos' of `rowLabelLabels'
*Store the label in local to be used later
local rowLabels_final `" `rowLabels_final' "`row_label'" "'
}
*Use variable label if option is specified
else if `ROWVARLABEL_USED' {
*Get the variable label used for this variable
local var_label : variable label `balancevar'
*Remove leading or trailing spaces
local var_label = trim("`var_label'")
*Make sure varlabel is not empty
if "`var_label'" != "" {
*Store the label in local to be used later
local rowLabels_final `" `rowLabels_final' "`var_label'" "'
}
*If var lable empty, use var name instead
else {
*Store the label in local to be used later
local rowLabels_final `" `rowLabels_final' "`balancevar'" "'
}
}
*Otherwise use the variable name
else {
*Store the label in local to be used later
local rowLabels_final `" `rowLabels_final' "`balancevar'" "'
}
}
}
/***********************************************
************************************************/
*Creating title rows
/*************************************************
************************************************/
** The titles consist of three rows across all
* columns of the table. Each row is one local
local titlerow1 ""
local titlerow2 ""
local titlerow3 `""Variable""'
** The titles consist of three rows across all
* columns of the table. Each row is one local
local texrow1 ""
local texrow2 ""
local texrow3 `"Variable"'
** Set titlw SE if standard errors are used (default)
* or SD if standard deviation is used
local variance_type "SE"
if `STDEV_USED' == 1 local variance_type "SD"
*Prepare title for column showing onle N or N and cluster
if "`vce_type'" != "cluster" {
local N_title "N"
}
else {
local N_title "N/[Clusters]"
}
*********************************************
*Generating titles for each value of groupvar
** Tempvar corresponding that will store the final
* order for the group the observation belongs to
tempvar groupOrder
gen `groupOrder' = .
*Loop over the number of groups
forvalues groupOrderNum = 1/`GRPVAR_NUM_GROUPS' {
*Get the code and label corresponding to the group
local groupLabel : word `groupOrderNum' of `grpLabels_final'
local groupCode : word `groupOrderNum' of `ORDER_OF_GROUPS'
* Make sure special characters are displayed correctly
local texGroupLabel : subinstr local groupLabel "%" "\%" , all
local texGroupLabel : subinstr local texGroupLabel "_" "\_" , all
local texGroupLabel : subinstr local texGroupLabel "&" "\&" , all
local texGroupLabel : subinstr local texGroupLabel "\$" "\\\\\\\$" , all
*Prepare a row to store onerow values for each group
if `ONEROW_USED' == 1 local onerow_`groupOrderNum' ""
*Assign the group order to observations that belong to this group
replace `groupOrder' = `groupOrderNum' if `grpvar' == `groupCode'
*Create one more column for N if N is displayesd in column instead of row
if `ONEROW_USED' == 0 {
local titlerow1 `"`titlerow1' _tab "" _tab " (`groupOrderNum') " "'
local titlerow2 `"`titlerow2' _tab "" _tab "`groupLabel'" "'
local titlerow3 `"`titlerow3' _tab "`N_title'" _tab "Mean/`variance_type'" "'
local texrow1 `"`texrow1' & \multicolumn{2}{c}{(`groupOrderNum')} "'
local texrow2 `"`texrow2' & \multicolumn{2}{c}{`texGroupLabel'} "'
local texrow3 `"`texrow3' & `N_title' & Mean/`variance_type' "'
}
else {
local titlerow1 `"`titlerow1' _tab " (`groupOrderNum') " "'
local titlerow2 `"`titlerow2' _tab "`groupLabel'" "'
local titlerow3 `"`titlerow3' _tab "Mean/`variance_type'" "'
local texrow1 `"`texrow1' & (`groupOrderNum') "'
local texrow2 `"`texrow2' & `texGroupLabel' "'
local texrow3 `"`texrow3' & Mean/`variance_type' "'
}
}
***********************************************************
*Generating titles for sample total if total() is specified
if `TOTAL_USED' {
*Add one more column group
local totalColNumber = `GRPVAR_NUM_GROUPS' + 1
*If onerow used, then add a local to store the total num obs
if `ONEROW_USED' == 1 local onerow_tot ""
local tot_label Total
if `TOTALLABEL_USED' local tot_label `totallabel'
* Make sure special characters are displayed correctly
local tex_tot_label : subinstr local tot_label "%" "\%" , all
local tex_tot_label : subinstr local tex_tot_label "_" "\_" , all
local tex_tot_label : subinstr local tex_tot_label "&" "\&" , all
local tex_tot_label : subinstr local tex_tot_label "\$" "\\\\\$" , all
*Create one more column for N if N is displayesd in column instead of row
if `ONEROW_USED' == 0 {
local titlerow1 `"`titlerow1' _tab "" _tab " (`totalColNumber') " "'
local titlerow2 `"`titlerow2' _tab "" _tab "`tot_label'" "'
local titlerow3 `"`titlerow3' _tab "`N_title'" _tab "Mean/`variance_type'" "'
local texrow1 `"`texrow1' & \multicolumn{2}{c}{(`totalColNumber')}"'
local texrow2 `"`texrow2' & \multicolumn{2}{c}{`tex_tot_label'} "'
local texrow3 `"`texrow3' & `N_title' & Mean/`variance_type' "'
}
else {
local titlerow1 `"`titlerow1' _tab " (`totalColNumber') " "'
local titlerow2 `"`titlerow2' _tab "`tot_label'" "'
local titlerow3 `"`titlerow3' _tab "Mean/`variance_type'" "'
local texrow1 `"`texrow1' & (`totalColNumber') "'
local texrow2 `"`texrow2' & `tex_tot_label' "'
local texrow3 `"`texrow3' & Mean/`variance_type' "'
}
}
************************************************
*Generating titles for each test of diff in mean
if `TTEST_USED' | `NORMDIFF_USED' {
if `CONTROL_USED' {
iecontrolheader "`control'" "`ORDER_OF_GROUPS'" "`GRPVAR_NUM_GROUPS'" ///
`TTEST_USED' `PTTEST_USED' `NORMDIFF_USED' ///
`" `titlerow1' "' `" `titlerow2' "' `" `titlerow3' "' `" `texrow3' "'
}
else {
ienocontrolheader "`GRPVAR_NUM_GROUPS'" ///
`TTEST_USED' `PTTEST_USED' `NORMDIFF_USED' ///
`" `titlerow1' "' `" `titlerow2' "' `" `titlerow3' "' `" `texrow3' "'
}
local titlerow1 `"`r(titlerow1)'"'
local titlerow2 `"`r(titlerow2)'"'
local titlerow3 `"`r(titlerow3)'"'
local texrow3 `"`r(texrow3)'"'
local ttest_pairs `"`r(ttest_pairs)'"'
local testPairCount : list sizeof ttest_pairs
if `testPairCount' > 0 {
if `TTEST_USED' {
local texrow1 `" `texrow1' & \multicolumn{`testPairCount'}{c}{t-test} "'
if `PTTEST_USED' == 1 {
local texrow2 `"`texrow2' & \multicolumn{`testPairCount'}{c}{p-value} "'
}
else {
local texrow2 `"`texrow2' & \multicolumn{`testPairCount'}{c}{Difference} "'
}
}
if `NORMDIFF_USED' {
local texrow1 `"`texrow1' & \multicolumn{`testPairCount'}{c}{Normalized} "'
local texrow2 `"`texrow2' & \multicolumn{`testPairCount'}{c}{difference} "'
}
}
*texrow3 created in loop above
}
************************************************
*Add column for F-test of joint equality
if `FEQTEST_USED' {
local titlerow1 `"`titlerow1' _tab "F-test""'
local titlerow2 `"`titlerow2' _tab "for joint""'
local titlerow3 `"`titlerow3' _tab "orthogonality""'
local texrow1 `" `texrow1' & \multicolumn{1}{c}{F-test} "'
local texrow2 `" `texrow2' & \multicolumn{1}{c}{for joint}"'
local texrow3 `" `texrow3' & \multicolumn{1}{c}{orthogonality}"'
}
****************************
*Writing titles to textfile
*Create a temporary textfile
tempname textname
tempfile textfile
*Write the title rows defined above
cap file close `textname'
file open `textname' using "`textfile'", text write replace
file write `textname' ///
`titlerow1' _n ///
`titlerow2' _n ///
`titlerow3' _n
file close `textname'
********************
*texfile
*Count number of columns in table
if `TEXCOLWIDTH_USED' == 0 local colstring l
else local colstring p{`texcolwidth'}
forvalues repeat = 1/`NUM_COL_GRP_TOT' {
*Add at least one column per group and for total if used
local colstring "`colstring'c"
*Add another column if N is displyaed in column and not row
if !`ONEROW_USED'{
local colstring "`colstring'c"
}
}
*Add one column per test pair
if `TTEST_USED' {
forvalues repeat = 1/`testPairCount' {
local colstring "`colstring'c"
}
}
*Add another column if F-test for equality of means is included
if `FEQTEST_USED'{
local colstring "`colstring'c"
}
*Add another column if normalized difference is included
if `NORMDIFF_USED'{
forvalues repeat = 1/`testPairCount' {
local colstring "`colstring'c"
}
}
*Create a temporary texfile
tempname texname
tempfile texfile
****Write texheader if full document option was selected
*Everyhting here is the tex headers
capture file close `texname'
if `TEXDOC_USED' {
file open `texname' using "`texfile'", text write replace
file write `texname' ///
"%%% Table created in Stata by iebaltab (https://github.com/worldbank/ietoolkit)" _n ///
"" _n ///
"\documentclass{article}" _n ///
"" _n ///
"% ----- Preamble " _n ///
"\usepackage[utf8]{inputenc}" _n ///
"\usepackage{adjustbox}" _n
file write `texname' ///
"% ----- End of preamble " _n ///
"" _n ///
" \begin{document}" _n ///
"" _n ///
"\begin{table}[!htbp]" _n ///
"\centering" _n
* Write tex caption if specified
if `CAPTION_USED' {
file write `texname' `"\caption{`texcaption'}"' _n
}
* Write tex label if specified
if `LABEL_USED' {
file write `texname' `"\label{`texlabel'}"' _n
}
file write `texname' "\begin{adjustbox}{max width=\textwidth}" _n
file close `texname'
}
file open `texname' using "`texfile'", text write append
file write `texname' ///
"\begin{tabular}{@{\extracolsep{5pt}}`colstring'}" _n ///
"\\[-1.8ex]\hline \hline \\[-1.8ex]" _n
file close `texname'
*Write the title rows defined above
capture file close `texname'
file open `texname' using "`texfile'", text write append
file write `texname' ///
"`texrow1' \\" _n ///
"`texrow2' \\" _n ///
"`texrow3' \\ \hline \\[-1.8ex] " _n
file close `texname'
/***********************************************
***********************************************/
*Running the regression for the t-test
*for each variable in varlist
/************************************************
************************************************/
*** Setting default values or specified values for fixed effects and clusters
**********************************
*Preparing fixed effect option
if !`FIX_EFFECT_USED' {
** If a fixed effect var is not specified,
* then a constant fixed effect is here generated.
* A constent fixed effect leaves the areg
* unaffected
tempvar fixedeffect
gen `fixedeffect' = 1
}
**********************************
*Preparing cluster option
if `VCE_USED' {
** The varname for cluster is
* prepared to be put in the areg
* options
local error_estm vce(`vce')
}
**********************************
*Preparing weight option
local weight_option ""
if `WEIGHT_USED' {
** The varname for weight is prepared to be put in the reg options
local weight_option "[`weight_type' = `weight_var']"
}
** Create locals that control the warning table
*Mean test warnings
local warn_means_num 0
local warn_ftest_num 0
*Joint test warnings
local warn_joint_novar_num 0
local warn_joint_lovar_num 0
local warn_joint_robus_num 0
*** Create columns with means and sd for this row
local tex_line_space 0pt
foreach balancevar in `balancevars' {
*Get the rowlabels prepared above one at the time
gettoken row_label rowLabels_final : rowLabels_final
*Start the tableRow string with the label defined
local tableRowUp `""`row_label'""'
local tableRowDo `" "'
*Make sure special characters in variable labels are displayed correctly
local texrow_label : subinstr local row_label "%" "\%" , all
local texrow_label : subinstr local texrow_label "_" "\_" , all
local texrow_label : subinstr local texrow_label "[" "{[}" , all
local texrow_label : subinstr local texrow_label "&" "\&" , all
local texrow_label : subinstr local texrow_label "\$" "\\\\\\\$" , all
local texRow `""`texrow_label'""'
*** Replacing missing value
** This option can be used to get a uniform N across all
* variables even if the variable is missing for some
* observations. When specifying this option, a dummy is
* created indicating all HHs that have a missing value
* for this variable. Missing values for the varaible is
* then set to zero, and in the areg used for testing the
* differences in means, the dummy is included as a control.
* Note that this will slightly distort the mean as well.
*Create option string
local replaceoptions
*Sopecify differently based on all missing or only regualr missing
if `BALMISS_USED' local replaceoptions `" `replaceoptions' replacetype("`balmiss'") "'
if `BALMISSREG_USED' local replaceoptions `" `replaceoptions' replacetype("`balmissreg'") regonly "'
*Add group variable if the replace type is group mean
if "`balmiss'" == "groupmean" local replaceoptions `" `replaceoptions' groupvar(`grpvar') groupcodes("`GRP_CODE_LEVELS'") "'
if "`balmissreg'" == "groupmean" local replaceoptions `" `replaceoptions' groupvar(`grpvar') groupcodes("`GRP_CODE_LEVELS'") "'
*Set the minimum number of observations to allow means to be set from
if `MISSMINMEAN_USED' == 1 local replaceoptions `" `replaceoptions' minobsmean(`missminmean') "'
if `MISSMINMEAN_USED' == 0 local replaceoptions `" `replaceoptions' minobsmean(10) "'
*Excute the command. Code is found at the bottom of this ado file
if (`BALMISS_USED' | `BALMISSREG_USED') iereplacemiss `balancevar', `replaceoptions'
*** Run the regressions
forvalues groupNumber = 1/`GRPVAR_NUM_GROUPS' {
reg `balancevar' if `groupOrder' == `groupNumber' `weight_option', `error_estm'
*Number of observation for this balancevar for this group
local N_`groupNumber' = e(N)
local N_`groupNumber' : display %9.0f `N_`groupNumber''
*If clusters used, number of clusters in this balance var for this group
if "`vce_type'" == "cluster" {
local N_clust_`groupNumber' = e(N_clust)
local N_clust_`groupNumber' : display %9.0f `N_clust_`groupNumber''
local N_clust_`groupNumber' = trim("`N_clust_`groupNumber''")
local N_clustex_`groupNumber' = "{[}`N_clust_`groupNumber'']"
local N_clust_`groupNumber' = "[`N_clust_`groupNumber'']"
}
*Load values from matrices into scalars
local mean_`groupNumber' = _b[_cons]
local se_`groupNumber' = _se[_cons]
local di_mean_`groupNumber' : display `diformat' `mean_`groupNumber''
*Display variation in Standard errors (default) or in Standard Deviations
if `STDEV_USED' == 0 {
*Format Standard Errors
local di_var_`groupNumber' : display `diformat' `se_`groupNumber''
}
else {
*Calculate Standard Deviation
local sd_`groupNumber' = `se_`groupNumber'' * sqrt(`N_`groupNumber'')
*Format Standard Deviation
local di_var_`groupNumber' : display `diformat' `sd_`groupNumber''
}
*Remove leading zeros from excessive fomrat
local N_`groupNumber' =trim("`N_`groupNumber''")
local di_mean_`groupNumber' =trim("`di_mean_`groupNumber''")
local di_var_`groupNumber' =trim("`di_var_`groupNumber''")
*Test that N is the same for each group across all vars
if `ONEROW_USED' == 0 {
local tableRowUp `"`tableRowUp' _tab "`N_`groupNumber''" _tab "`di_mean_`groupNumber''" "'
local tableRowDo `"`tableRowDo' _tab "`N_clust_`groupNumber''" _tab "[`di_var_`groupNumber'']" "'
if `SHOW_NCLUSTER' == 0 {
local texRow `"`texRow' " & `N_`groupNumber'' & \begin{tabular}[t]{@{}c@{}} `di_mean_`groupNumber'' \\ (`di_var_`groupNumber'') \end{tabular}" "'
}
if `SHOW_NCLUSTER' == 1 {
local texRow `"`texRow' " & \begin{tabular}[t]{@{}c@{}} `N_`groupNumber'' \\ `N_clustex_`groupNumber'' \end{tabular} & \begin{tabular}[t]{@{}c@{}} `di_mean_`groupNumber'' \\ (`di_var_`groupNumber'') \end{tabular}" "'
}
}
else {
*Test if the number of observations is the same in each group accross all balance vars
if "`onerow_`groupNumber''" == "" {
*Store the obs num
local onerow_`groupNumber' = `N_`groupNumber''
}
*If not, then check that the obs num is the same as before
else if !(`onerow_`groupNumber'' == `N_`groupNumber'') {
// EDIT: Take max number of observations
if (`onerow_`groupNumber'' <= `N_`groupNumber'') {
local onerow_`groupNumber' = `N_`groupNumber''
}
/*
*option onerow not allowed if N is different
noi display as error "{phang}The number of observations for `balancevar' is different compared to other balance variables within the same group. You can therefore not use the option onerow. Run the command without the option onerow to see which group does not have the same number of observations with non-missing values across all balance variables.{p_end}"
error 198
*/
}
*If cluster is usedTest if the number of clusters is the same in each group accross all balance vars
if "`vce_type'" == "cluster" {
if "`oneclstrow_`groupNumber''" == "" {
*Store the obs num
local oneclstrow_`groupNumber' = `N_clust_`groupNumber''
}
*If not, then check that the obs num is the same as before
else if !(`oneclstrow_`groupNumber'' == `N_clust_`groupNumber'') {
*option onerow not allowed if N is different
noi display as error "{phang}The number of clusters for `balancevar' is differenet compared to other balance variables within the same group. You can therefore not use the option onerow. Run the command without the option onerow to see which group does not have the same number of clusters with non-missing values across all balance variables.{p_end}"
error 198
}
}
*Either this is the first balance var or num obs are identical, so write columns
local tableRowUp `"`tableRowUp' _tab "`di_mean_`groupNumber''" "'
local tableRowDo `"`tableRowDo' _tab "[`di_var_`groupNumber'']" "'
local texRow `"`texRow' " & \begin{tabular}[t]{@{}c@{}} `di_mean_`groupNumber'' \\ (`di_var_`groupNumber'') \end{tabular}" "'
}
}
if `TOTAL_USED' {
reg `balancevar' `weight_option', `error_estm'
local N_tot = e(N)
local N_tot : display %9.0f `N_tot'
*If clusters used, number of clusters in this balance var for this group
if "`vce_type'" == "cluster" {
local N_clust_tot = e(N_clust)
local N_clust_tot : display %9.0f `N_clust_tot'
local N_clust_tot = trim("`N_clust_tot'")
local N_clustex_tot = "{[}`N_clust_tot']"
local N_clust_tot = "[`N_clust_tot']"
}
*Load values from matrices into scalars
local mean_tot = _b[_cons]
local se_tot = _se[_cons]
local mean_tot : display `diformat' `mean_tot'
*Display variation in Standard errors (default) or in Standard Deviations
if `STDEV_USED' == 0 {
*Format Standard Errors
local var_tot : display `diformat' `se_tot'
}
else {
*Calculate Standard Deviation
local sd_tot = `se_tot' * sqrt(`N_tot')
*Format Standard Deviation
local var_tot : display `diformat' `sd_tot'
}
*Remove leading zeros from excessive fomrat
local N_tot =trim("`N_tot'")
local mean_tot =trim("`mean_tot'")
local var_tot =trim("`var_tot'")
*Test that N is the same for each group across all vars
if `ONEROW_USED' == 0 {
local tableRowUp `"`tableRowUp' _tab "`N_tot'" _tab "`mean_tot'" "'
local tableRowDo `"`tableRowDo' _tab "`N_clust_tot'" _tab "[`var_tot']" "'
if `SHOW_NCLUSTER' == 0 {
local texRow `"`texRow' " & `N_tot' & \begin{tabular}[t]{@{}c@{}} `mean_tot' \\ (`var_tot') \end{tabular}" "'
}
if `SHOW_NCLUSTER' == 1 {
local texRow `"`texRow' " & \begin{tabular}[t]{@{}c@{}} `N_tot' \\ `N_clustex_tot' \end{tabular} & \begin{tabular}[t]{@{}c@{}} `mean_tot' \\ (`var_tot') \end{tabular}" "'
}
}
else {
*Test if the first balance var
if "`onerow_tot'" == "" {
*Store the obs num
local onerow_tot = `N_tot'
}
*If not, then check that the obs num is the same as before
else if !(`onerow_tot' == `N_tot') {
*option onerow not allowed if N is different
noi display as error "{phang}The number of observations for all groups are not the same for `balancevar' compare to at least one other balance variables. Run the command without the option onerow to see which group does not have the same number of observations with non-missing values across all balance variables. This happened in the total column which can be an indication of a serious bug. Please email this erro message to kbjarkefur@worldbank.org{p_end}"
error 198
}
*If cluster is usedTest if the number of clusters is the same in each group accross all balance vars
if "`vce_type'" == "cluster" {
if "`oneclstrow_tot'" == "" {
*Store the obs num
local oneclstrow_tot = `N_clust_tot'
}
*If not, then check that the obs num is the same as before
else if !(`oneclstrow_tot' == `N_clust_tot') {
*option onerow not allowed if N is different
noi display as error "{phang}The number of clusters fora ll groups for `balancevar' is differenet compared to other balance variables. You can therefore not use the option onerow. Run the command without the option onerow to see which balance variable does not have the same number of clusters with non-missing values as the other balance variables.{p_end}"
error 198
}
}
*Either this is the first balance var or num obs are identical, so write columns
local tableRowUp `"`tableRowUp' _tab "`mean_tot'" "'
local tableRowDo `"`tableRowDo' _tab "[`var_tot']" "'
local texRow `"`texRow' " & \begin{tabular}[t]{@{}c@{}} `mean_tot' \\ (`var_tot') \end{tabular}" "'
}
}
*** Create the columns with t-tests for this row
if `TTEST_USED' {
foreach ttest_pair of local ttest_pairs {
*Create a local for each group in the test
*pair from the test_pair local created above
local undscr_pos = strpos("`ttest_pair'","_")
local first_group = substr("`ttest_pair'",1,`undscr_pos'-1)
local second_group = substr("`ttest_pair'", `undscr_pos'+1,.)
*Create the local with the difference to be displayed in the table
local diff_`ttest_pair' = `mean_`first_group'' - `mean_`second_group'' //means from section above
*Create a temporary varaible used as the dummy to indicate
*which observation is in the first and in the second group
*in the test pair. Since all other observations are mission,
*this variable also exculde all observations in neither of
*the groups from the test regression
tempvar tempvar_thisGroupInPair
gen `tempvar_thisGroupInPair' = . //default is missing, and obs not in this pair will remain missing
replace `tempvar_thisGroupInPair' = 0 if `groupOrder' == `first_group'
replace `tempvar_thisGroupInPair' = 1 if `groupOrder' == `second_group'
*The command mean is used to test that there is variation
*in the balance var across these two groups. The regression
*that includes fixed effects and covariaties might run without
*error even if there is no variance across the two groups. The
*local varloc will determine if an error or a warning will be
*thrown or if the test results will be replaced with an "N/A".
if "`error_estm'" != "vce(robust)" local mean_error_estm `error_estm' //Robust not allowed in mean, but mean here is used to test something else
mean `balancevar', over(`tempvar_thisGroupInPair') `mean_error_estm'
mat var = e(V)
local varloc = max(var[1,1],var[2,2])
*This is the regression where we test differences.
reg `balancevar' `tempvar_thisGroupInPair' `covariates' i.`fixedeffect' `weight_option', `error_estm'
*Testing result and if valid, write to file with or without stars
if `varloc' == 0 {
local warn_means_num = `warn_means_num' + 1
local warn_means_name`warn_means_num' "t-test"
local warn_means_group`warn_means_num' "(`first_group')-(`second_group')"
local warn_means_bvar`warn_means_num' "`balancevar'"
local tableRowUp `" `tableRowUp' _tab "N/A" "'
local tableRowDo `" `tableRowDo' _tab " " "'
local texRow `" `texRow' " & N/A" "'
}
else {
*Perform the t-test and store p-value in pttest
test `tempvar_thisGroupInPair'
local pttest = r(p)
*If p-test option is used
if `PTTEST_USED' == 1 {
local ttest_output = `pttest'
}
*Otherwise display differences
else {
local ttest_output = `diff_`ttest_pair''
}
*Format the output
local ttest_output : display `diformat' `ttest_output'
*Add stars
foreach ttest_p_level in `p1star' `p2star' `p3star' {
if `pttest' < `ttest_p_level' local ttest_output "`ttest_output'*"
}
*Print row
local tableRowUp `" `tableRowUp' _tab "`ttest_output'" "'
local tableRowDo `" `tableRowDo' _tab " " "'
local texRow `" `texRow' " & `ttest_output'" "'
}
}
}
*** Create the columns with normalized difference for this row
if `NORMDIFF_USED' {
foreach normdiff_pair of local ttest_pairs {
*Create a local for each group in the test
*pair from the test_pair local created above
local undscr_pos = strpos("`normdiff_pair'","_")
local first_group = substr("`normdiff_pair'",1,`undscr_pos'-1)
local second_group = substr("`normdiff_pair'", `undscr_pos'+1,.)
*Create the local with the difference to be displayed in the table
local diff_`normdiff_pair' = `mean_`first_group'' - `mean_`second_group'' //means from section above
*Calculate standard deviation for sample of interest
sum `balancevar' if inlist(`groupOrder',`first_group',`second_group')
*Testing result and if valid, write to file with or without stars
if r(sd) == 0 {
local warn_means_num = `warn_means_num' + 1
local warn_means_name`warn_means_num' "Norm diff"
local warn_means_group`warn_means_num' "(`first_group')-(`second_group')"
local warn_means_bvar`warn_means_num' "`balancevar'"
local tableRowUp `" `tableRowUp' _tab "N/A" "'
local tableRowDo `" `tableRowDo' _tab " " "'
local texRow `" `texRow' " & N/A" "'
}
else {
*Create the local with the normalized difference
local normdiff_`normdiff_pair' = `diff_`normdiff_pair''/r(sd)
*Format the output
local normdiff_output : display `diformat' `normdiff_`normdiff_pair''
*Print row
local tableRowUp `" `tableRowUp' _tab "`normdiff_output'" "'
local tableRowDo `" `tableRowDo' _tab " " "'
local texRow `" `texRow' " & `normdiff_output'" "'
}
}
}
*** Create the columns with F-tests for this row
if `FEQTEST_USED' {
* Run regression
reg `balancevar' i.`grpvar' `covariates' i.`fixedeffect' `weight_option', `error_estm'
* Calculate input for F-test: i. will drop the lowest value of
* grpvar, so we'll do the same
local 1st_level = strpos("`GRP_CODE_LEVELS'"," ") + 1
local FEQTEST_CODE_LEVELS = substr("`GRP_CODE_LEVELS'",`1st_level',.)
* Calculate input for F-test: loop through levels to create input
local ftest_input ""
foreach grpCode of local FEQTEST_CODE_LEVELS {
local ftest_input = " `ftest_input' `grpCode'.`grpvar'="
}
test `ftest_input' 0
local pfeqtest = r(p)
local ffeqtest = r(F)
*Check if the test is valid. If not, print N/A and error message.
*Is yes, print test
if "`ffeqtest'" == "." {
local warn_ftest_num = `warn_ftest_num' + 1
local warn_ftest_bvar`warn_ftest_num' "`balancevar'"
local tableRowUp `" `tableRowUp' _tab "N/A" "'
local tableRowDo `" `tableRowDo' _tab " " "'
local texRow `" `texRow' " & N/A" "'
}
else {
*Create the F-test output
*If p-test option is used, display p-value
if `PFTEST_USED' {
local feqtest_output = `pfeqtest'
}
*Otherwise display differences
else {
local feqtest_output = `ffeqtest'
}
*Store f-value
local feqtest_output : display `diformat' `feqtest_output'
*Adding stars
foreach feqtest_p_level in `p1star' `p2star' `p3star' {
if `pfeqtest' < `feqtest_p_level' local feqtest_output `feqtest_output'*
}
*Print row
local tableRowUp `" `tableRowUp' _tab "`feqtest_output'" "'
local tableRowDo `" `tableRowDo' _tab " " "'
local texRow `" `texRow' " & `feqtest_output'" "'
}
}
*Write the row for this balance var to file.
file open `textname' using "`textfile'", text write append
file write `textname' ///
`tableRowUp' _n ///
`tableRowDo' _n
file close `textname'
file open `texname' using "`texfile'", text write append
file write `texname' ///
`texRow' " \rule{0pt}{`tex_line_space'}\\" _n
file close `texname'
* We'll now add more space between the lines
if `TEXVSPACE_USED' == 0 local tex_line_space 3ex
else local tex_line_space `texvspace'
}
***Write N row if onerow used
if `ONEROW_USED' == 1 {
*Variable column i.e. row title
local tableRowN `""N""'
local texRowN `"N"'
local tableRowClstr `""Clusters""'
local texRowClstr `"Clusters"'
*Loop over all groups
forvalues groupOrderNum = 1/`GRPVAR_NUM_GROUPS' {
*Prepare the row based on the numbers from above
local tableRowN `" `tableRowN' _tab "`onerow_`groupOrderNum''" "'
local texRowN `" `texRowN' & `onerow_`groupOrderNum'' "'
local tableRowClstr `" `tableRowClstr' _tab "`oneclstrow_`groupOrderNum''" "'
local texRowClstr `" `texRowClstr' & `oneclstrow_`groupOrderNum'' "'
}
if `TOTAL_USED' {
*Prepare the row based on the numbers from above
local tableRowN `" `tableRowN' _tab "`onerow_tot'" "'
local texRowN `" `texRowN' & `onerow_tot' "'
local tableRowClstr `" `tableRowClstr' _tab "`oneclstrow_tot'" "'
local texRowClstr `" `texRowClstr' & `oneclstrow_tot' "'
}
*Write the N prepared above
file open `textname' using "`textfile'", text write append
file write `textname' `tableRowN' _n
if "`vce_type'" == "cluster" file write `textname' `tableRowClstr' _n
file close `textname'
file open `texname' using "`texfile'", text write append
file write `texname' " `texRowN' \rule{0pt}{`tex_line_space'} \\" _n
if "`vce_type'" == "cluster" file write `texname' " `texRowClstr' \\" _n
file close `texname'
}
/***********************************************
***********************************************/
*Running the regression for the F-tests
/************************************************
************************************************/
if `FTEST_USED' {
if `ONEROW_USED' == 0 {
local ftestMulticol = 1 + (2*`NUM_COL_GRP_TOT')
}
else {
local ftestMulticol = 1 + `NUM_COL_GRP_TOT'
}
if `PFTEST_USED' {
local Fstat_row `" "F-test of joint significance (p-value)" "'
local Fstat_texrow `" "\multicolumn{`ftestMulticol'}{@{} l}{F-test of joint significance (p-value)}" "'
}
else {
local Fstat_row `" "F-test of joint significance (F-stat)" "'
local Fstat_texrow `" "\multicolumn{`ftestMulticol'}{@{} l}{F-test of joint significance (F-stat)}" "'
}
local Fobs_row `" "F-test, number of observations" "'
local Fobs_texrow `" "\multicolumn{`ftestMulticol'}{@{} l}{F-test, number of observations}" "'
*Create empty cells for all the group columns
forvalues groupIteration = 1/`GRPVAR_NUM_GROUPS' {
local Fstat_row `" `Fstat_row' _tab "" "'
local Fobs_row `" `Fobs_row' _tab "" "'
*Add one more column if onerow is not used
if `ONEROW_USED' == 0 {
local Fstat_row `" `Fstat_row' _tab "" "'
local Fobs_row `" `Fobs_row' _tab "" "'
}
}
*Create empty cells for total columns if total is used
if `TOTAL_USED' {
local Fstat_row `" `Fstat_row' _tab "" "'
local Fobs_row `" `Fobs_row' _tab "" "'
*Add one more column if onerow is not used
if `ONEROW_USED' == 0 {
local Fstat_row `" `Fstat_row' _tab "" "'
local Fobs_row `" `Fobs_row' _tab "" "'
}
}
*Local used to count number of f-test that trigered warnings
local warn_joint_novar_num 0
local warn_joint_lovar_num 0
local warn_joint_robus_num 0
local fmiss_error 0
*Run the F-test on each pair
foreach ttest_pair of local ttest_pairs {
*Create a local for each group in the test
*pair from the test_pair local created above
local undscr_pos = strpos("`ttest_pair'","_")
local first_group = substr("`ttest_pair'",1,`undscr_pos'-1)
local second_group = substr("`ttest_pair'", `undscr_pos'+1,.)
*Create the local with the difference to be displayed in the table
tempvar tempvar_thisGroupInPair miss
gen `tempvar_thisGroupInPair' = .
replace `tempvar_thisGroupInPair' = 0 if `groupOrder' == `first_group'
replace `tempvar_thisGroupInPair' = 1 if `groupOrder' == `second_group'
***** Testing if any obs have missing values in any og the varaibles used in the f_test
*Loop over all balvars and seperate them with a comma
local balvars_comma_seperated
foreach balancevar of local balancevars {
local balvars_comma_seperated `balvars_comma_seperated' , `balancevar'
}
*Remove the first comman before the first variable
local balvars_comma_seperated = subinstr("`balvars_comma_seperated'" ,",","",1)
*Generate a variable equal to 1 if any balance var is missing
gen `miss' = missing(`balvars_comma_seperated') if !missing(`tempvar_thisGroupInPair')
*Count number obs in this test pair with non-missing values for all balance variables.
count if `miss' == 0
if `r(N)' == 0 {
noi di as error "{phang}F-test not possible. All observations are dropped from the f-test regression as no observation in the f-test between (`first_group')-(`second_group') has non-missing values in all balance variables. Disable the f-test option."
error 2000
}
else if `r(N)' == 1 {
noi di as error "{phang}F-test not possible. All but one observation are dropped from the f-test regression as only that one observation in the f-test between (`first_group')-(`second_group') has non-missing values in all balance variables. Disable the f-test option."
error 2001
}
*Count number obs in this test pair with missing value in at least one balance variable.
count if `miss' == 1
if `r(N)' != 0 & `F_MISS_OK' == 0 {
local fmiss_error 1 //Used to throw error below
local fmiss_error_list `fmiss_error_list', (`first_group')-(`second_group')
}
**********
* Run the regression for f-test
reg `tempvar_thisGroupInPair' `balancevars' `covariates' i.`fixedeffect' `weight_option', `error_estm'
*This F is calculated using fixed effects as well
local reg_F "`e(F)'"
local reg_F_N "`e(N)'"
*Test all balance variables for joint significance
cap testparm `balancevars'
local test_F "`r(F)'"
local test_F_p "`r(p)'"
**********
* Write to table
* No variance in either groups mean in any of the balance vars. F-test not possible to calculate
if _rc == 111 {
local warn_joint_novar_num = `warn_joint_novar_num' + 1
local warn_joint_novar`warn_joint_novar_num' "(`first_group')-(`second_group')"
local Fstat_row `" `Fstat_row' _tab "N/A" "'
local Fobs_row `" `Fobs_row' _tab "N/A" "'
local Fstat_texrow `" `Fstat_texrow' " & N/A" "'
local Fobs_texrow `" `Fobs_texrow' " & N/A" "'
}
* Collinearity between one balance variable and the dependent treatment dummy
else if "`test_F'" == "." {
local warn_joint_lovar_num = `warn_joint_lovar_num' + 1
local warn_joint_lovar`warn_joint_lovar_num' "(`first_group')-(`second_group')"
local Fstat_row `" `Fstat_row' _tab "N/A" "'
local Fobs_row `" `Fobs_row' _tab "N/A" "'
local Fstat_texrow `" `Fstat_texrow' " & N/A" "'
local Fobs_texrow `" `Fobs_texrow' " & N/A" "'
}
* F-test is incorreclty specified, error in this code
else if _rc != 0 {
noi di as error "F-test not valid. Please report this error to kbjarkefur@worldbank.org"
error _rc
}
* F-tests possible to calculate
else {
* Robust singularity, see help file. Similar to overfitted model. Result possible but probably not reliable
if "`reg_F'" == "." {
local warn_joint_robus_num = `warn_joint_robus_num' + 1
local warn_joint_robus`warn_joint_robus_num' "(`first_group')-(`second_group')"
}
*If p-test option is used
if `PFTEST_USED' {
local ftest_output = `test_F_p'
}
*Otherwise display differences
else {
local ftest_output = `test_F'
}
*Store f-value
local ftest_output : display `diformat' `ftest_output'
local reg_F_N : display %9.0f `reg_F_N'
*Adding stars
foreach ftest_p_level in `p1star' `p2star' `p3star' {
if `test_F_p' < `ftest_p_level' local ftest_output `ftest_output'*
}
*Store the f-stat value with stars to the f-stat row
local Fstat_row `" `Fstat_row' _tab "`ftest_output'" "'
local Fobs_row `" `Fobs_row' _tab "`reg_F_N'" "'
local Fstat_texrow `" `Fstat_texrow' " & `ftest_output'" "'
local Fobs_texrow `" `Fobs_texrow' " & `reg_F_N'" "'
}
}
*******
* Throw missing values in f-test warning
if `fmiss_error' == 1 {
*Remove the first comman before the first variable
local fmiss_error_list = subinstr("`fmiss_error_list'" ,",","",1)
noi di as error "{phang}F-test is possible but perhaps not advisable. Some observations have missing values in some of the balance variables and therfore dropped from the f-stat regression. This happened in the f-tests for the following group(s): [`fmiss_error_list']. Solve this by manually restricting the balance table using if or in, or disable the f-test, or by using option {help iebaltab:balmiss()}. Suppress this error message by using option {help iebaltab:fmissok}"
error 416
}
*******
* Write the f-test row to file
file open `textname' using "`textfile'", text write append
file write `textname' `Fstat_row' _n
if !`F_NO_OBS' file write `textname' `Fobs_row' _n
file close `textname'
file open `texname' using "`texfile'", text write append
file write `texname' "\hline" _n
file write `texname' `Fstat_texrow' " \\" _n
if !`F_NO_OBS' file write `texname' `Fobs_texrow' " \\" _n
file close `texname'
}
/***********************************************
************************************************/
*Compile and display warnings (as opposed to errors in relation to t and f tests.)
/*************************************************
************************************************/
local anywarning = max(`warn_means_num',`warn_ftest_num',`warn_joint_novar_num', `warn_joint_lovar_num' ,`warn_joint_robus_num')
local anywarning_F = max(`warn_joint_novar_num', `warn_joint_lovar_num' ,`warn_joint_robus_num')
if `anywarning' > 0 {
noi di as text ""
noi di as error "{hline}"
noi di as error "{pstd}Stata issued one or more warnings in relation to the tests in this balance table. Read the warning(s) below carefully before using the values generated for this table.{p_end}"
noi di as text ""
if `warn_means_num' > 0 {
noi di as text "{pmore}{bf:Difference-in-Means Tests:} The variance in both groups listed below is zero for the variable indicated and a difference-in-means test between the two groups is therefore not valid. Tests are reported as N/A in the table.{p_end}"
noi di as text ""
noi di as text "{col 9}{c TLC}{hline 11}{c TT}{hline 12}{c TT}{hline 37}{c TRC}"
noi di as text "{col 9}{c |}{col 13}Test{col 21}{c |}{col 25}Group{col 34}{c |}{col 39}Balance Variable{col 72}{c |}"
noi di as text "{col 9}{c LT}{hline 11}{c +}{hline 12}{c +}{hline 37}{c RT}"
forvalues warn_num = 1/`warn_means_num' {
noi di as text "{col 9}{c |}{col 11}`warn_means_name`warn_num''{col 21}{c |}{col 23}`warn_means_group`warn_num''{col 34}{c |}{col 37}`warn_means_bvar`warn_num''{col 72}{c |}"
}
noi di as text "{col 9}{c BLC}{hline 11}{c BT}{hline 12}{c BT}{hline 37}{c BRC}"
noi di as text ""
}
if `warn_ftest_num' > 0 {
noi di as text "{pmore}{bf:F-Test for Joint Orthogonality:} The variance all groups is zero for the variable indicated and a test of joint orthogonality for all groups is therefore not valid. Tests are reported as N/A in the table.{p_end}"
noi di as text ""
noi di as text "{col 9}{c TLC}{hline 25}{c TRC}"
noi di as text "{col 9}{c |}{col 13} Balance Variable{col 35}{c |}"
noi di as text "{col 9}{c LT}{hline 25}{c RT}"
forvalues warn_num = 1/`warn_ftest_num' {
noi di as text "{col 9}{c |}{col 12}`warn_ftest_bvar`warn_num''{col 35}{c |}"
}
noi di as text "{col 9}{c BLC}{hline 25}{c BRC}"
noi di as text ""
}
if `anywarning_F' > 0 {
noi di as text "{pmore}{bf:Joint Significance Tests:} F-tests are not possible to perform or unreliable. See below for details:{p_end}"
noi di as text ""
if `warn_joint_novar_num' > 0 {
noi di as text "{pmore}In the following tests, F-tests were not valid as all variables were omitted in the joint significance test due to collinearity. Tests are reported as N/A in the table.{p_end}"
noi di as text ""
noi di as text "{col 9}{c TLC}{hline 12}{c TRC}"
noi di as text "{col 9}{c |}{col 13}Test{col 22}{c |}"
noi di as text "{col 9}{c LT}{hline 12}{c RT}"
forvalues warn_num = 1/`warn_joint_novar_num' {
noi di as text "{col 9}{c |}{col 12}`warn_joint_novar`warn_num''{col 22}{c |}"
}
noi di as text "{col 9}{c BLC}{hline 12}{c BRC}"
noi di as text ""
}
if `warn_joint_lovar_num' > 0 {
noi di as text "{pmore}In the following tests, F-tests are not valid as the variation in, and the covariation between, the balance variables is too close to zero in the joint test. This could be due to many reasons, but is usually due to a balance variable with high correlation with group dummy. Tests are reported as N/A in the table.{p_end}"
noi di as text ""
noi di as text "{col 9}{c TLC}{hline 12}{c TRC}"
noi di as text "{col 9}{c |}{col 13}Test{col 22}{c |}"
noi di as text "{col 9}{c LT}{hline 12}{c RT}"
forvalues warn_num = 1/`warn_joint_lovar_num' {
noi di as text "{col 9}{c |}{col 12}`warn_joint_lovar`warn_num''{col 22}{c |}"
}
noi di as text "{col 9}{c BLC}{hline 12}{c BRC}"
noi di as text ""
}
if `warn_joint_robus_num' > 0 {
noi di as text "{pmore}In the following tests, F-tests are possible to calculate, but Stata issued a warning. Read more about this warning {help j_robustsingular:here}. Tests are reported with F-values and significance stars (if applicable), but these results might be unreliable.{p_end}"
noi di as text ""
noi di as text "{col 9}{c TLC}{hline 12}{c TRC}"
noi di as text "{col 9}{c |}{col 13}Test{col 22}{c |}"
noi di as text "{col 9}{c LT}{hline 12}{c RT}"
forvalues warn_num = 1/`warn_joint_robus_num' {
noi di as text "{col 9}{c |}{col 12}`warn_joint_robus`warn_num''{col 22}{c |}"
}
noi di as text "{col 9}{c BLC}{hline 12}{c BRC}"
noi di as text ""
}
}
noi di as error "{pstd}Stata issued one or more warnings in relation to the tests in this balance table. Read the warning(s) above carefully before using the values generated for this table.{p_end}"
noi di as error "{hline}"
noi di as text ""
}
/***********************************************
************************************************/
*Add notes to the bottom of the table
/*************************************************
************************************************/
* Prepare the covariate note.
if `COVARIATES_USED' == 1 {
local covars_comma = ""
*Loop over all covariates and add a comma
foreach covar of local covariates {
if "`covars_comma'" == "" {
local covars_comma "and `covar'"
local one_covar 1
}
else {
local covars_comma "`covar', `covars_comma'"
local one_covar 0
}
}
* If only one covariate, remove and from local and make note singular, and if multiple covariates, make note plural.
if `one_covar' == 1 {
local covars_comma = subinstr("`covars_comma'" , "and ", "", .)
local covar_note "The covariate variable `covars_comma' is included in all estimation regressions. "
}
else {
local covar_note "The covariate variables `covars_comma' are included in all estimation regressions. "
}
}
*** Prepare the notes used below
local fixed_note "Fixed effects using variable `fixedeffect' are included in all estimation regressions. "
local stars_note "***, **, and * indicate significance at the `p3star_percent', `p2star_percent', and `p1star_percent' percent critical level. "
if `PTTEST_USED' == 1 {
local ttest_note "The value displayed for t-tests are p-values. "
}
else {
local ttest_note "The value displayed for t-tests are the differences in the means across the groups. "
}
if `PFTEST_USED' == 1 {
local ftest_note "The value displayed for F-tests are p-values. "
}
else {
local ftest_note "The value displayed for F-tests are the F-statistics. "
}
if `VCE_USED' == 1 {
*Display variation in Standard errors (default) or in Standard Deviations
if `STDEV_USED' == 0 {
*Standard Errors string
local variance_type_name "Standard errors"
}
else {
*Standard Deviation string
local variance_type_name "Standard deviations"
}
if "`vce_type'" == "robust" local error_est_note "`variance_type_name' are robust. "
if "`vce_type'" == "cluster" local error_est_note "`variance_type_name' are clustered at variable `cluster_var'. "
if "`vce_type'" == "bootstrap" local error_est_note "`variance_type_name' are estimeated using bootstrap. "
}
if `WEIGHT_USED' == 1 {
local f_weights "fweights fw freq weight"
local a_weights "aweights aw"
local p_weights "pweights pw"
local i_weights "iweights iw"
if `:list weight_type in f_weights' local weight_type = "frequency"
else if `:list weight_type in a_weights' local weight_type = "analytical"
else if `:list weight_type in p_weights' local weight_type = "probability"
else if `:list weight_type in i_weights' local weight_type = "importance"
local weight_note "Observations are weighted using variable `weight_var' as `weight_type' weights."
}
if `BALMISS_USED' == 1 | `BALMISSREG_USED' == 1 {
if `BALMISS_USED' == 1 local balmiss_note "All missing values in balance variables are treated as zero."
if `BALMISSREG_USED' == 1 local balmiss_note "Regular missing values in balance variables are treated as zero, {help missing:extended missing values} are still treated as missing."
local BALMISS_USED = 1
}
if `COVMISS_USED' == 1 | `COVMISSREG_USED' == 1 {
if `COVMISS_USED' == 1 local covmiss_note "All missing values in covariate variables are treated as zero."
if `COVMISSREG_USED' == 1 local covmiss_note "Regular missing values in covariate variables are treated as zero, {help missing:extended missing values} are still treated as missing."
local COVMISS_USED = 1
}
*** Write notes to file according to specificiation
if `NOTECOMBINE_USED' == 1 {
*Combine all notes used to one line
*Delete the locals corresponding to options not used
if `FTEST_USED' == 0 local ftest_note ""
if `VCE_USED' == 0 local error_est_note ""
if `WEIGHT_USED' == 0 local weight_note ""
if `FIX_EFFECT_USED' == 0 local fixed_note ""
if `COVARIATES_USED' == 0 local covar_note ""
if `BALMISS_USED' == 0 local balmiss_note ""
if `COVMISS_USED' == 0 local covmiss_note ""
if `STARSNOADD_USED' == 1 local stars_note ""
*Write to file
file open `textname' using "`textfile'", text write append
file write `textname' "`tblnote' `ttest_note'`ftest_note'`error_est_note'`fixed_note'`covar_note'`weight_note'`balmiss_note'`covmiss_note'`stars_note'" _n
file close `textname'
}
else if `NONOTE_USED' == 1 {
*Nonote used. Only add manually entered note
file open `textname' using "`textfile'", text write append
if `NOTE_USED' file write `textname' "`tblnote'" _n
file close `textname'
}
else {
file open `textname' using "`textfile'", text write append
if `NOTE_USED' file write `textname' "`tblnote'" _n
file write `textname' "`ttest_note'" _n
if `FTEST_USED' file write `textname' "`ftest_note'" _n
if `VCE_USED' file write `textname' "`error_est_note'" _n
if `FIX_EFFECT_USED' file write `textname' "`fixed_note'" _n
if `COVARIATES_USED' file write `textname' "`covar_note'" _n
if `BALMISS_USED' file write `textname' "`balmiss_note'" _n
if `COVMISS_USED' file write `textname' "`covmiss_note'" _n
if !`STARSNOADD_USED' file write `textname' "`stars_note'" _n
file close `textname'
}
*** Write tex footer
*Latex is always combnote, so prep for that
*Delete the locals corresponding to options not used
if `FTEST_USED' == 0 local ftest_note ""
if `VCE_USED' == 0 local error_est_note ""
if `WEIGHT_USED' == 0 local weight_note ""
if `FIX_EFFECT_USED' == 0 local fixed_note ""
if `COVARIATES_USED' == 0 local covar_note ""
if `BALMISS_USED' == 0 local balmiss_note ""
if `COVMISS_USED' == 0 local covmiss_note ""
if `STARSNOADD_USED' == 1 local stars_note ""
* Make sure variables with underscore in name are displayed correctly in the note
local notes_list "tblnote error_est_note weight_note fixed_note covar_note"
foreach note of local notes_list {
local `note' : subinstr local `note' "_" "\_" , all
local `note' : subinstr local `note' "%" "\%" , all
local `note' : subinstr local `note' "&" "\&" , all
local `note' : subinstr local `note' "\$" "\\\$" , all
}
*Calculate total number of columns
if `TEXCOLWIDTH_USED' == 0 local totalColNo = strlen("`colstring'")
else {
local colstrBracePos = strpos("`colstring'","}")
local nonLabelCols = substr("`colstring'",`colstrBracePos'+1,.)
local totalColNo = strlen("`nonLabelCols'") +1
}
*Set default tex note width (note width is a multiple of text width.
*if none is manually specified, default is text width)
if `NOTEWIDTH_USED' == 0 local texnotewidth = 1
file open `texname' using "`texfile'", text write append
file write `texname' ///
"\hline \hline \\[-1.8ex]" _n
** Write notes to file according to specificiation
*If no automatic notes are used, write only manual notes
if `NONOTE_USED' & `NOTE_USED' {
file write `texname' ///
"%%% This is the note. If it does not have the correct margins, use texnotewidth() option or change the number before '\textwidth' in line below to fit it to table size." _n ///
"\multicolumn{`totalColNo'}{@{} p{`texnotewidth'\textwidth}}" _n ///
`"{\textit{Notes}: `tblnote'}"' _n
}
else if ! `NONOTE_USED' {
*Write to file
file write `texname' ///
"%%% This is the note. If it does not have the correct margins, edit text below to fit to table size." _n ///
"\multicolumn{`totalColNo'}{@{}p{`texnotewidth'\textwidth}}" _n ///
`"{\textit{Notes}: `tblnote' `ttest_note'`ftest_note'`error_est_note'`fixed_note'`covar_note'`weight_note'`balmiss_note'`covmiss_note'`stars_note'}"' _n
}
file write `texname' ///
"\end{tabular}" _n
file close `texname'
if `TEXDOC_USED' {
file open `texname' using "`texfile'", text write append
file write `texname' ///
"\end{adjustbox}" _n ///
"\end{table}" _n ///
"\end{document}" _n
file close `texname'
}
/***********************************************
************************************************/
*Export and restore data unless other specified
/*************************************************
************************************************/
*Restore from orginial preserve at top of command
restore
if !( `BROWSE_USED' | `SAVE_BROWSE_USED' ) preserve
******************************************
*Load the text file with the data prepared
*Insheet was replaced by import delimited by Stata 13
if c(version) < 13 {
*For Stata 11 and 12
insheet using "`textfile'", tab clear
}
else {
*For Stata 13 and more recent
import delimited using "`textfile'", clear delimiters("\t")
}
******************************************
*Export the data according to user specification
*Export to excel format
if `SAVE_USED' {
export excel using `"`save'"', `replace'
noi di as result `"{phang}Balance table saved to: {browse "`save'":`save'} "'
}
*Export to tex format
if `SAVE_TEX_USED' {
copy "`texfile'" `"`savetex'"', `replace'
noi di as result `"{phang}Balance table saved to: {browse "`savetex'":`savetex'} "'
}
if !( `BROWSE_USED' | `SAVE_BROWSE_USED' ) restore
}
end
*This function is used to test the input in the options
*that replace missing values. Only three strings are allowed
*as arguemnts
cap program drop iereplacestringtest
program define iereplacestringtest
args optionname replacetypestring
if !("`replacetypestring'" == "zero" | "`replacetypestring'" == "mean" | "`replacetypestring'" == "groupmean") {
noi display as error "{phang}The string entered in option `optionname'(`replacetypestring') is not a valid replace type string. Only zero, mean and groupmean is allowed. See {help iebaltab:help iebaltab} for more details.{p_end}"
error 198
}
end
*This function replaces zeros in balance variables
*or covariates according to the users specifications.
cap program drop iereplacemiss
program define iereplacemiss
syntax varname, replacetype(string) [minobsmean(numlist) regonly groupvar(varname) groupcodes(string)]
*Which missing values to change. Standard or extended.
if "`regonly'" == "" {
local misstype "`varlist' >= ."
}
else {
local misstype "`varlist' == ."
}
*Set the minimum number of observations
*a mean is allowed to be based on.
if "`minobsmean'" == "" {
local minobs 10 //10 is the default
}
else {
*setting it to a user defiend value
local minobs `minobsmean'
}
*Change the missing values accord
*to the users specifications
if "`replacetype'" == "zero" {
*Missing is set to zero
replace `varlist' = 0 if `misstype'
}
else if "`replacetype'" == "mean" {
*Generate the mean for all observations in the table
sum `varlist'
*Test that there are enough observations to base the mean on
if `r(N)' < `minobs' {
noi display as error "{phang}Not enough observations. There are less than `minobs' observations with a nonmissing value in `varlist'. Missing values can therefore not be set to the mean. Click {stata tab `varlist', missing} for detailed information.{p_end}"
error 2001
}
*Missing values are set to the mean
replace `varlist' = `r(mean)' if `misstype'
}
else if "`replacetype'" == "groupmean" {
*Loop over each group code
foreach code of local groupcodes {
*Generate the mean for all observations in the group
sum `varlist' if `groupvar' == `code'
*Test that there are enough observations to base the mean on
if `r(N)' == 0 {
noi display as error "{phang}No observations. All values are missing in variable `varlist' for group `code' in variable `groupvar' and missing values can therefore not be set to the group mean. Click {stata tab `varlist' if `groupvar' == `code', missing} for detailed information.{p_end}"
error 2000
}
if `r(N)' < `minobs' {
noi display as error "{phang}Not enough observations. There are less than `minobs' observations in group `code' in variable `groupvar' with a non missing value in `varlist'. Missing values can therefore not be set to the group mean. Click {stata tab `varlist' if `groupvar' == `code', missing} for detailed information.{p_end}"
error 2001
}
*Missing values are set to the mean of the group
replace `varlist' = `r(mean)' if `misstype' & `groupvar' == `code'
}
}
end
cap program drop iecontrolheader
program define iecontrolheader, rclass
args control ORDER_OF_GROUPS GRPVAR_NUM_GROUPS TTEST_USED PTTEST_USED NORMDIFF_USED titlerow1 titlerow2 titlerow3 texrow3
local ttest_pairs ""
*The t-tests will only be between control and each of the other groups
*Get the order of the control group
local ctrlGrpPos : list posof "`control'" in ORDER_OF_GROUPS
*Storing a local of all the test pairs
forvalues second_ttest_group = 1/`GRPVAR_NUM_GROUPS' {
if `second_ttest_group' != `ctrlGrpPos' {
local ttest_pairs "`ttest_pairs' `ctrlGrpPos'_`second_ttest_group'"
}
}
if `TTEST_USED' {
forvalues second_ttest_group = 1/`GRPVAR_NUM_GROUPS' {
*Include all groups apart from the control group itself
if `second_ttest_group' != `ctrlGrpPos' {
*Adding title rows for the t-test.
local titlerow1 `"`titlerow1' _tab "t-test""'
if `PTTEST_USED' local titlerow2 `"`titlerow2' _tab "p-value""'
else local titlerow2 `"`titlerow2' _tab "Difference""'
local titlerow3 `"`titlerow3' _tab "(`ctrlGrpPos')-(`second_ttest_group')""'
local texrow3 `" `texrow3' & (`ctrlGrpPos')-(`second_ttest_group') "'
}
}
}
if `NORMDIFF_USED' {
forvalues second_ttest_group = 1/`GRPVAR_NUM_GROUPS' {
*Include all groups apart from the control group itself
if `second_ttest_group' != `ctrlGrpPos' {
local titlerow1 `"`titlerow1' _tab "Normalized""'
local titlerow2 `"`titlerow2' _tab "difference""'
local titlerow3 `"`titlerow3' _tab "(`ctrlGrpPos')-(`second_ttest_group')""'
local texrow3 `" `texrow3' & (`ctrlGrpPos')-(`second_ttest_group') "'
}
}
}
return local titlerow1 `"`titlerow1'"'
return local titlerow2 `"`titlerow2'"'
return local titlerow3 `"`titlerow3'"'
return local texrow3 `"`texrow3'"'
return local ttest_pairs `"`ttest_pairs'"'
end
cap program drop ienocontrolheader
program define ienocontrolheader, rclass
args GRPVAR_NUM_GROUPS TTEST_USED PTTEST_USED NORMDIFF_USED titlerow1 titlerow2 titlerow3 texrow3
local ttest_pairs ""
*The t-tests will be all cominations of groups
forvalues first_ttest_group = 1/`GRPVAR_NUM_GROUPS' {
** To guarantee that all combination of groups are included
* but no duplicates are possible, start next loop one integer
* higher than the first group
local nextPossGroup = `first_ttest_group' + 1
*Storing a local of all the test pairs
forvalues second_ttest_group = `nextPossGroup'/`GRPVAR_NUM_GROUPS' {
local ttest_pairs "`ttest_pairs' `first_ttest_group'_`second_ttest_group'"
}
}
*Adding title rows for the t-test.
if `TTEST_USED' {
forvalues first_ttest_group = 1/`GRPVAR_NUM_GROUPS' {
** To guarantee that all combination of groups are included
* but no duplicates are possible, start next loop one integer
* higher than the first group
local nextPossGroup = `first_ttest_group' + 1
forvalues second_ttest_group = `nextPossGroup'/`GRPVAR_NUM_GROUPS' {
local titlerow1 `"`titlerow1' _tab "t-test""'
if `PTTEST_USED' local titlerow2 `"`titlerow2' _tab "p-value""'
else local titlerow2 `"`titlerow2' _tab "Difference""'
local titlerow3 `"`titlerow3' _tab "(`first_ttest_group')-(`second_ttest_group')""'
local texrow3 `" `texrow3' & (`first_ttest_group')-(`second_ttest_group') "'
}
}
}
*Adding title rows for the normalized differences.
if `NORMDIFF_USED' {
forvalues first_ttest_group = 1/`GRPVAR_NUM_GROUPS' {
** To guarantee that all combination of groups are included
* but no duplicates are possible, start next loop one integer
* higher than the first group
local nextPossGroup = `first_ttest_group' + 1
forvalues second_ttest_group = `nextPossGroup'/`GRPVAR_NUM_GROUPS' {
local titlerow1 `"`titlerow1' _tab "Normalized""'
local titlerow2 `"`titlerow2' _tab "difference""'
local titlerow3 `"`titlerow3' _tab "(`first_ttest_group')-(`second_ttest_group')""'
local texrow3 `" `texrow3' & (`first_ttest_group')-(`second_ttest_group') "'
}
}
}
return local titlerow1 `"`titlerow1'"'
return local titlerow2 `"`titlerow2'"'
return local titlerow3 `"`titlerow3'"'
return local texrow3 `"`texrow3'"'
return local ttest_pairs `"`ttest_pairs'"'
end