Difference between revisions of "Iecodebook"

Jump to: navigation, search
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<code>iecodebook</code> is the final command in the Stata package created by [https://www.worldbank.org/en/research/dime/data-and-analytics DIME Analytics], <code>[[iefieldkit]]</code>. After [[Primary Data Collection|data collection]] is complete, <code>iecodebook</code> allows the [[Impact Evaluation Team|research team]] to automatically perform the repetitive steps involved in [[Data Cleaning|cleaning data]] before further [[Data Analysis|analysis]]. As the name suggests, the <code>iecodebook</code> command is structured around Excel-based '''codebooks''', which allow researchers to perform and [[Data Documentation|document]] data cleaning tasks in Excel itself, instead of using '''do-files'''.  
 
<code>iecodebook</code> is the final command in the Stata package created by [https://www.worldbank.org/en/research/dime/data-and-analytics DIME Analytics], <code>[[iefieldkit]]</code>. After [[Primary Data Collection|data collection]] is complete, <code>iecodebook</code> allows the [[Impact Evaluation Team|research team]] to automatically perform the repetitive steps involved in [[Data Cleaning|cleaning data]] before further [[Data Analysis|analysis]]. As the name suggests, the <code>iecodebook</code> command is structured around Excel-based '''codebooks''', which allow researchers to perform and [[Data Documentation|document]] data cleaning tasks in Excel itself, instead of using '''do-files'''.  
 
== Read First ==
 
== Read First ==
* [[Stata Coding Practices|Stata coding practices]].
+
* Please refer to [[Stata Coding Practices|Stata coding practices]] for coding best practices in Stata.
* <code>[[iefieldkit]]</code>.
+
* <code>iecodebook</code> is part of the package <code>[[iefieldkit]]</code>, which has been developed by [https://www.worldbank.org/en/research/dime/data-and-analytics DIME Analytics].
 
* The <code>iecodebook</code> and its subcommands allow the [[Impact Evaluation Team|research team]] to rapidly [[Iecodebook#Apply|clean]], [[Iecodebook#Harmonize|harmonize]], and [[Iecodebook#Export|document]] datasets using '''codebooks'''.
 
* The <code>iecodebook</code> and its subcommands allow the [[Impact Evaluation Team|research team]] to rapidly [[Iecodebook#Apply|clean]], [[Iecodebook#Harmonize|harmonize]], and [[Iecodebook#Export|document]] datasets using '''codebooks'''.
 
* Codebooks allow researchers to document the cleaned data in a format that is both human and machine-readable.
 
* Codebooks allow researchers to document the cleaned data in a format that is both human and machine-readable.
* To install <code>iecodebook</code>, type <code>ssc install iecodebook</code> in Stata.
+
* To install <code>iecodebook</code> and all the commands in the <code>[[iefieldkit]]</code> package, type <syntaxhighlight lang="Stata" inline>ssc install iefieldkit</syntaxhighlight> in Stata.
* To install all the commands in the <code>[[iefieldkit]]</code> package, type <code>ssc install iefieldkit</code> in Stata.
+
* For instructions and available options, type <syntaxhighlight lang="Stata" inline>help iecodebook</syntaxhighlight>.
* For instructions and available options, type <code>help iecodebook</code>.
 
  
 
== Overview ==
 
== Overview ==
Line 27: Line 26:
 
=== Syntax ===
 
=== Syntax ===
 
The following line of code creates an <code>apply</code> template with the relevant dataset. The template is named '''filename.xlsx''' in this case.
 
The following line of code creates an <code>apply</code> template with the relevant dataset. The template is named '''filename.xlsx''' in this case.
iecodebook template using "''filename.xlsx''"
+
<syntaxhighlight lang="Stata">iecodebook template using "filename.xlsx"</syntaxhighlight>
  
 
The following line of code applies the changes to the dataset. It saves the codebook with the same name, that is, '''filename.xlsx'''.
 
The following line of code applies the changes to the dataset. It saves the codebook with the same name, that is, '''filename.xlsx'''.
iecodebook apply using "''filename.xlsx''"
+
<syntaxhighlight lang="Stata">iecodebook apply using "filename.xlsx"
     , [drop] [missingvalues(''#'' "''label''" [''#'' "''label''" ...])]
+
     , [drop] [missingvalues(# "label" [# "label" ...])]</syntaxhighlight>
  
 
=== Implementation ===  
 
=== Implementation ===  
Line 37: Line 36:
 
==== Step 1: Load the dataset ====
 
==== Step 1: Load the dataset ====
 
First, load the dataset that you want to clean. In this case, the dataset is named '''"auto.dta"'''.
 
First, load the dataset that you want to clean. In this case, the dataset is named '''"auto.dta"'''.
sysuse auto.dta , clear
+
<syntaxhighlight lang="Stata" line>sysuse auto.dta , clear</syntaxhighlight>
  
 
==== Step 2: Create template ====   
 
==== Step 2: Create template ====   
 
Next, run the following code to create the '''template codebook''', which is named '''"cleaning.xlsx"''' in this case.
 
Next, run the following code to create the '''template codebook''', which is named '''"cleaning.xlsx"''' in this case.
iecodebook template using "cleaning.xlsx"
+
<syntaxhighlight lang="Stata" line start="2">iecodebook template using "cleaning.xlsx"</syntaxhighlight>
 
 
 
This produces the template codebook in '''Figure 1''', which shows the state of the data before you make changes.
 
This produces the template codebook in '''Figure 1''', which shows the state of the data before you make changes.
  
Line 53: Line 51:
 
* '''''label''''': Fill the '''''label''''' columns in the template to specify what the <code>label</code> command will do to the variables in the dataset. You can use this to give more information about a variable.
 
* '''''label''''': Fill the '''''label''''' columns in the template to specify what the <code>label</code> command will do to the variables in the dataset. You can use this to give more information about a variable.
  
* '''''choices''''': Enter a label name in the '''''choices''''' column to apply a particular value label for a variable. Also create the corresponding value label in the '''''choices''''' sheet. Every template already includes a demo '''yesno''' label as a guide. For example, in '''Figure 3''', we have applied the '''yesno''' value label to the variable with the name '''domestic''', to indicate if a car is domestically made or not.  We have also applied the '''origin''' value label to the variable with the name '''foreign'''. We will also create the '''origin''' value label in the '''''choices''''' sheet, for instance by assigning values of '''"0"''' to '''domestic''', and '''"1"''' to '''foreign'''.
+
* '''''choices''''': Enter a label name in the '''''choices''''' column to apply a particular value label for a variable. Also create the corresponding value label in the '''''choices''''' sheet. Every template already includes a demo <code>yesno</code> label as a guide. For example, in '''Figure 3''', we have applied the <code>yesno</code> value label to the variable with the name '''domestic''', to indicate if a car is domestically made or not.  We have also applied the '''origin''' value label to the variable with the name '''foreign'''. We will also create the '''origin''' value label in the '''''choices''''' sheet, for instance by assigning values of '''"0"''' to '''domestic''', and '''"1"''' to '''foreign'''.
  
 
* '''''recode:current''''': Use the usual syntax <code>(''rule'') [(''rule'') ...]</code> in the '''''recode:current''''' column to <code>recode</code> data values. For example, in '''Figure 3''', we use <code>(0=1)(1=0)</code> to indicate that the label for the value of '''"0"''' has now been assigned to '''"1"''' , and the label for the value of '''"1"''' has now been assigned to '''"0"'''. Using the example above, this means that now '''foreign''' has a value of '''"0"''', and '''domestic''' has a value of '''"1"'''.
 
* '''''recode:current''''': Use the usual syntax <code>(''rule'') [(''rule'') ...]</code> in the '''''recode:current''''' column to <code>recode</code> data values. For example, in '''Figure 3''', we use <code>(0=1)(1=0)</code> to indicate that the label for the value of '''"0"''' has now been assigned to '''"1"''' , and the label for the value of '''"1"''' has now been assigned to '''"0"'''. Using the example above, this means that now '''foreign''' has a value of '''"0"''', and '''domestic''' has a value of '''"1"'''.
Line 63: Line 61:
 
==== Step 4: Apply cleaning commands ====
 
==== Step 4: Apply cleaning commands ====
 
Finally, apply the changes using the following command, and save the codebook with the same name as before - '''"cleaning.xlsx"'''.
 
Finally, apply the changes using the following command, and save the codebook with the same name as before - '''"cleaning.xlsx"'''.
iecodebook apply using "cleaning.xlsx"
+
<syntaxhighlight lang="Stata" line start="3">iecodebook apply using "cleaning.xlsx"</syntaxhighlight>
  
 
'''Note:''' Keep the following points in mind when using <code>iecodebook apply</code>.
 
'''Note:''' Keep the following points in mind when using <code>iecodebook apply</code>.
Line 70: Line 68:
 
* '''Dropping variables:''' You can also use <code>iecodebook apply</code> to drop variables from the dataset, using the <code>drop</code> option, or using single periods (<code>.</code>).
 
* '''Dropping variables:''' You can also use <code>iecodebook apply</code> to drop variables from the dataset, using the <code>drop</code> option, or using single periods (<code>.</code>).
 
** <code>drop</code>: You can simply use the <code>drop</code> option to drop variables from the dataset that have no final variable name under the '''''name''''' column.
 
** <code>drop</code>: You can simply use the <code>drop</code> option to drop variables from the dataset that have no final variable name under the '''''name''''' column.
** '''Single period (<code>.</code>):''' Alternatively, you can place a single period (<code>.</code>) under the '''''name''''' column to drop variables one by one.  
+
** Single period (<code>.</code>): Alternatively, you can place a single period (<code>.</code>) under the '''''name''''' column to drop variables one by one.  
  
* <code>missingvalues()</code>: The <code>missingvalues()</code> option allows you to use '''global''' missing-value codes for all value labels. For example, this is often <code>.</code> or <code>-99</code>.
+
* <code>missingvalues()</code>: The <code>missingvalues()</code> option allows you to add '''global''' missing-value codes to all value labels. For example, if you use extended missing values consistently you can have <code>.a</code> or <code>.n</code> have the same meaning in all responses.
  
 
* '''Value labels:''' You will have to manually recreate all value label lists in the '''''choices''''' sheet. However, you can copy-paste data labels from your original dataset to the '''''choices_current''''' sheet.
 
* '''Value labels:''' You will have to manually recreate all value label lists in the '''''choices''''' sheet. However, you can copy-paste data labels from your original dataset to the '''''choices_current''''' sheet.
Line 78: Line 76:
 
== Append and Harmonize ==
 
== Append and Harmonize ==
 
A common task in [[Primary Data Collection|data collection]] is combining two or more sequential rounds of [[Field Surveys|surveys]], or combining similar [[Questionnaire Design|survey instruments]] that were used in different contexts. This is often a tricky process, and at least one of the datasets might not be correctly updated. In such a case, simply using the '''append''' command in Stata will not provide you with the desired structure for your dataset. In such cases, it is possible that certain aspects may not be synchronized or '''harmonized''' across the two datasets, such as:
 
A common task in [[Primary Data Collection|data collection]] is combining two or more sequential rounds of [[Field Surveys|surveys]], or combining similar [[Questionnaire Design|survey instruments]] that were used in different contexts. This is often a tricky process, and at least one of the datasets might not be correctly updated. In such a case, simply using the '''append''' command in Stata will not provide you with the desired structure for your dataset. In such cases, it is possible that certain aspects may not be synchronized or '''harmonized''' across the two datasets, such as:
* '''Variable names.'''
+
* '''Variable names'''
* '''Variable labels (including translations).'''
+
* '''Variable labels (including translations)'''
* '''Value labels.'''
+
* '''Value labels'''
* '''Data types.'''
+
* '''Data types'''
In these cases, '''<code>iecodebook append</code>''' offers a quick option to [[Data Documentation|document]] and resolve these differences across multiple datasets. The following steps list how the '''<code>iecodebook append</code>''' works.
+
In these cases, <code>iecodebook append</code> offers a quick option to [[Data Documentation|document]] and resolve these differences across multiple datasets. The following steps list how <code>iecodebook append</code> works.
# '''Create template:''' Just as in the case of '''<code>iecodebook apply</code>''', use '''<code>iecodebook template</code>''' to first convert the dataset into a template in Excel. In this template, each column describes different aspects of a variable, including '''''name''''', '''''label''''', '''''type''''', and so on. The only difference is that in this case, '''<code>iecodebook</code>''' also creates a new variable called '''survey''' by default. The value label for this variable will contain the name of the surveys that you specify under the '''surveys ( )''' option for '''<code>iecodebook template</code>'''.
+
# '''Create template:''' Just as in the case of <code>iecodebook apply</code>, use <code>iecodebook template</code> to first convert the dataset into a '''harmonization template''' in Excel. In this template, each column describes different aspects of a variable, including '''''name''''', '''''label''''', '''''type''''', and so on. The only difference is that in this case, <code>iecodebook</code> also creates a new variable called '''survey''' by default. The value label for this variable will contain the name of the surveys that you specify under the <code>surveys()</code> option for <code>iecodebook template</code>.
# '''Complete template:''' After this, you can simply fill out the template in Excel. In this template, you can specify the rules to '''append''' the datasets, and resolve differences across the two datasets. For instance, you can place certain variables in the same row, and '''<code>iecodebook append</code>''' will understand this to mean that we want those variables to have the same values under the '''''name''''', '''''label''''' and '''''choices''''' columns so that they can '''append''' properly.
+
# '''Complete template:''' After this, you can simply fill out the template in Excel. In this template, you can specify the rules to <code>append</code> the datasets, and resolve differences across the two datasets. For instance, you can place certain variables in the same row, and <code>iecodebook append</code> will understand this to mean that we want those variables to have the same values under the '''''name''''', '''''label''''' and '''''choices''''' columns so that they can <code>append</code> properly.
# '''Append datasets:''' The '''<code>iecodebook append</code>''' subcommand then reads the rules that you specify in the '''codebook template''', and uses them to finally '''append''' the datasets. The resulting output is a '''harmonized''' dataset with all the differences across the two datasets now resolved.
+
# '''Append datasets:''' The <code>iecodebook append</code> subcommand then reads the rules that you specify in the template, and uses them to finally <code>append</code> the datasets. The resulting output is a '''harmonized''' dataset with all the differences across the two datasets now resolved.
 
=== Syntax ===
 
=== Syntax ===
The general syntax of '''<code>iecodebook template</code>''' in this case is as follows:
+
The general syntax of <code>iecodebook template</code> in this case is as follows:
iecodebook template "''filename.dta''" "''filename.dta''" [...]
+
<syntaxhighlight lang="Stata" line start="4">iecodebook template "filename.dta" "filename.dta" [...] //
     using "''filename.xlsx''"
+
     using "filename.xlsx" //
     , surveys(''Survey1Name'' ''Survey2Name'' [...])
+
     , surveys(Survey1Name Survey2Name [...]) //
     [generate(varname)] [match]  
+
     [generate(varname)] [match]</syntaxhighlight>
  
The following is the syntax to run '''<code>iecodebook append</code>''' subcommand based on the rules you specify in the '''codebook''':
+
The following is the syntax to run <code>iecodebook append</code> subcommand based on the rules you specify in the '''harmonization template''':
iecodebook append "''filename.dta''" "''filename.dta''" [...]
+
<syntaxhighlight lang="Stata" line start="8">iecodebook append "filename.dta" "filename.dta" [...] //
     using "''filename.xlsx''"
+
     using "filename.xlsx" //
     , surveys(''Survey1Name'' ''Survey2Name'' [...])
+
     , surveys(Survey1Name Survey2Name [...]) //
     [generate(varname)] [keepall] [report] [replace]
+
     [generate(varname)] [keepall] [report] [replace] //
     [missingvalues(''#'' "''label''" [''#'' "''label''" ...])]
+
     [missingvalues(# "label" [# "label" ...])]</syntaxhighlight>
  
The following points explain the options that are used with the '''<code>iecodebook template</code>''' and '''<code>iecodebook append</code>''' subcommands:
+
The following points explain the options that are used with the <code>iecodebook template</code> and <code>iecodebook append</code> subcommands:
* '''match:''' The '''match''' option automatically aligns variables from other datasets in the same row if they share a name with a variable in the first dataset. It is optional for the '''template''' subcommand only.
+
* <code>match</code>: The <code>match</code> option automatically aligns variables from other datasets in the same row if they share a name with a variable in the first dataset. It is optional for the <code>template</code> subcommand only.
  
* '''surveys( ):''' The '''surveys( )''' option must be used with both subcommands, and the names you specify under this option must be the same for both subcommands. Specify the names of the surveys as a list of single words. '''<code>iecodebook</code>''' will look for these names in the '''codebook''' headers. The command will also create a '''survey''' variable in the resulting dataset by default. The value label for this variable will contain the name of the surveys that you specify under the '''surveys ( )''' option.
+
* <code>surveys()</code>: The <code>surveys()</code> option must be used with both subcommands, and the names you specify under this option must be the same for both subcommands. Specify the names of the surveys as a list of single words - <code>(''Survey1Name'' ''Survey2Name'' [...])</code>. <code>iecodebook</code> will look for these names in the headers of the codebook. The command will also create a '''survey''' variable in the resulting dataset by default. The value label for this variable will contain the name of the surveys that you specify under the <code>surveys()</code> option.
  
* '''generate( ):''' To change the name of the '''survey''' variable, use the '''generate( )''' option in both subcommands.
+
* <code>generate()</code>: To change the name of the '''survey''' variable, use the <code>generate()</code> option in both subcommands.
  
* '''report:''' The '''report''' option exports a '''codebook''' with the results of the resulting dataset for quick reference.
+
* <code>report</code>: The <code>report</code> option exports a codebook with the results of the resulting dataset for quick reference.
  
* '''replace:''' The '''replace''' option allows you to overwrite the existing file which contains the '''codebook'''.
+
* <code>replace</code>: The <code>replace</code> option allows you to overwrite the existing file which contains the codebook.
  
 
=== Implementation ===
 
=== Implementation ===
The following steps show how '''<code>iecodebook append</code>''' works in practice.
+
The following steps show how <code>iecodebook append</code> works in practice.
  
 
==== Step 1: Create two different datasets ====
 
==== Step 1: Create two different datasets ====
 
First, create two datasets that have similar data but different structures.
 
First, create two datasets that have similar data but different structures.
 
Run the following code for this.  
 
Run the following code for this.  
sysuse auto.dta , clear
+
<syntaxhighlight lang="Stata" line> sysuse auto.dta , clear
 
  save data1.dta , replace
 
  save data1.dta , replace
 
  rename price cost
 
  rename price cost
 
  rename mpg car_mpg
 
  rename mpg car_mpg
     recode foreign (0=1 "Domestic")(1=0 "Foreign") , gen(origin)
+
     recode foreign (0=1 "Domestic")(1=0 "Foreign") , gen(origin)  
     drop foreign
+
     drop foreign  
  save data2.dta , replace
+
  save data2.dta , replace</syntaxhighlight>
 
'''Note:''' We have used the same dataset, '''"auto.dta"''', to create two different datsets, '''"data1.dta"''' and '''"data2.dta"'''
 
'''Note:''' We have used the same dataset, '''"auto.dta"''', to create two different datsets, '''"data1.dta"''' and '''"data2.dta"'''
  
 
==== Step 2: Combine the datasets ====  
 
==== Step 2: Combine the datasets ====  
Next, combine the datasets to create a '''harmonization codebook template''' in Excel using '''<code>iecodebook template</code>'''. Name this file '''"harmonization.xlsx"''''. This is shown in '''Figure 3'''. Run the following code.
+
Next, combine the datasets to create a '''harmonization codebook template''' in Excel using <code>iecodebook template</code>. Name this file '''"harmonization.xlsx"''''. This is shown in '''Figure 3'''. Run the following code.
iecodebook template "data1.dta" "data2.dta" using "harmonization.xlsx"
+
<syntaxhighlight lang="Stata" line start="8"> iecodebook template "data1.dta" "data2.dta" //
clear, surveys(First Second)
+
    using "harmonization.xlsx" //
 +
    , surveys(First Second)</syntaxhighlight>
 
'''Note:''' The names of the surveys are '''First''' and '''Second'''. These names appear in the column names in '''Figure 3''' below as follows -  '''''name:First''''', '''''name:Second''''', '''''label:First''''', '''''label:Second''''', and so on.
 
'''Note:''' The names of the surveys are '''First''' and '''Second'''. These names appear in the column names in '''Figure 3''' below as follows -  '''''name:First''''', '''''name:Second''''', '''''label:First''''', '''''label:Second''''', and so on.
  
 
[[File:Append-temp.png|1000px|thumb|center|'''Figure 3: <code>iecodebook append</code> harmonization codebook template''']]
 
[[File:Append-temp.png|1000px|thumb|center|'''Figure 3: <code>iecodebook append</code> harmonization codebook template''']]
  
If you use the '''match''' option, the '''harmonization template''' will appear as shown in '''Figure 4''' below. Note the following about the '''match''' option:
+
If you use the <code>match</code> option, the '''harmonization template''' will appear as shown in '''Figure 4''' below. Note the following about the <code>match</code> option:
* In this case, the variables are ordered according to how they appear in the first dataset, that is, '''"data1.dta"'''. However, the order of these variables in the underlying dataset does not get affected, it is only for the purpose of the '''codebook'''.  
+
* In this case, the variables are ordered according to how they appear in the first dataset, that is, '''"data1.dta"'''. However, the order of these variables in the underlying dataset does not get affected, it is only for the purpose of the codebook.  
  
* '''<code>iecodebook</code>''' will never reorder variables beyond the functionality of the built-in '''append''' subcommand.
+
* <code>iecodebook</code> will never reorder variables beyond the functionality of the built-in <code>append</code> subcommand.
  
  
Line 143: Line 142:
  
 
==== Step 3: Modify the codebook ====
 
==== Step 3: Modify the codebook ====
Next, to resolve the differences between the two datasets - '''"data1.dta"''' and '''"data2.dta"''' , modify the completed '''codebook''' as shown in '''Figure 5'''. In order to '''harmonize''' the datasets, place variables from different datasets into the same row. This means that for '''<code>iecodebook append</code>''' to '''append''' properly, make sure that the variables have the same final variable names, labels, and value labels applied to them in the '''harmonization template'''. In our example, it means that for the variables that you want to '''append''', ensure that each of them have the same values under '''''name:First''''' and '''''name:Second''''' columns, and so on for the '''''label:''''' and '''''choices:''''' columns.  
+
Next, to resolve the differences between the two datasets - '''"data1.dta"''' and '''"data2.dta"''' , modify the completed codebook as shown in '''Figure 5'''. In order to '''harmonize''' the datasets, place variables from different datasets into the same row. This means that for <code>iecodebook append</code> to <code>append</code> properly, make sure that the variables have the same final variable names, labels, and value labels applied to them in the harmonization template. In our example, it means that for the variables that you want to <code>append</code>, ensure that each of them have the same values under '''''name:First''''' and '''''name:Second''''' columns, and so on for the '''''label:''''' and '''''choices:''''' columns.  
  
 
[[File:Harmonize-comp.png|1000px|thumb|center|'''Figure 5: <code>iecodebook append</code> codebook with harmonization instructions''']]
 
[[File:Harmonize-comp.png|1000px|thumb|center|'''Figure 5: <code>iecodebook append</code> codebook with harmonization instructions''']]
Line 149: Line 148:
  
 
'''Note:''' Keep the following points in mind when modifying the codebook.
 
'''Note:''' Keep the following points in mind when modifying the codebook.
* '''recode:''' You will need to handle the '''recode''' commands dataset-by-dataset, instead of just re-arranging the variables. Which is why there is one '''''recode:''''' column for each survey (which acts as a source of data), as well as '''''choices_''''' sheets for reference.  
+
* '''''recode:''''' '''columns:''' You will need to handle the <code>recode</code> commands dataset-by-dataset, instead of just re-arranging the variables. Which is why there is one '''''recode:''''' column for each survey (which acts as a source of data), as well as '''''choices_''''' sheets for reference.  
* '''Value labels:''' As with  '''<code>iecodebook apply</code>''', you will have to manually recreate the value label lists in the '''''choices''''' sheet.  However, you can copy-paste data labels from your original datasets to the '''''choices_First''''' and '''''choices_Second''''' sheets respectively. This is shown in '''Figure 6''' below.
+
* '''Value labels:''' As with  <code>iecodebook apply</code>, you will have to manually recreate the value label lists in the '''''choices''''' sheet.  However, you can copy-paste data labels from your original datasets to the '''''choices_First''''' and '''''choices_Second''''' sheets respectively. This is shown in '''Figure 6''' below.
  
  
Line 156: Line 155:
  
 
==== Step 4: Append the datasets ====
 
==== Step 4: Append the datasets ====
Finally, '''append''' the datasets and '''harmonize''' them using the following code. Save the '''codebook''' with the same name, that is, '''"harmonization.xlsx" '''.
+
Finally, <code>append</code> the '''harmonized''' datasets using the following code. Save the codebook with the same name, that is, '''"harmonization.xlsx" '''.
iecodebook append "data1.dta" "data2.dta" using "harmonization.xlsx"     
+
<syntaxhighlight lang="Stata" line start="11"> iecodebook append "data1.dta" "data2.dta" using "harmonization.xlsx"     
, surveys(First Second)
+
    , clear surveys(First Second)</syntaxhighlight>
  
'''Note:''' There are two important differences between the syntax for '''<code>iecodebook append</code>''' and '''<code>iecodebook apply</code>''':
+
'''Note:''' There are two important differences between the syntax for <code>iecodebook append</code> and <code>iecodebook apply</code>:
# '''Default is drop:''' The '''drop''' option is the default in the case of '''<code>iecodebook append</code>'''. That is, the command will only keep those variables to which you explicitly give final names in the '''''name''''' column. This is to encourage you to manually review each variable.
+
# '''Default is to drop:''' By default, the <code>iecodebook append</code> command will only keep those variables to which you explicitly give final names in the '''''name''''' column. This is to encourage you to manually review each variable.
# '''keepall:''' You may use the '''keepall''' option to retain all variables from all datasets, except the variables you have tagged for deletion by entering a '''single period (" . ")''' in the '''''name''''' column. This allows you to override the default drop option. However, you should still check the final dataset carefully because '''appending''' variables without explicitly reviewing them may again cause problems with synchronization.
+
# <code>keepall</code>: You may use the <code>keepall</code> option to retain all variables from all datasets, except the variables you have tagged for deletion by entering a single period (<code>.</code>) in the '''''name''''' column. This allows you to override the default drop option. However, you should still check the final dataset carefully because if you <code>append</code> variables without explicitly reviewing them, it may again cause problems with synchronization.
  
 
==== Output ====
 
==== Output ====
The combined dataset will yield the following crosstabs. If you specify the '''report''' option, '''<code>iecodebook</code>'''  will also create another '''codebook''' titled '''"codebook report.xlsx"''', in the same location as the '''harmonization codebook'''. This report [[Data Documentation|documents]] the final state of the dataset for quick reference.
+
The combined dataset will yield the following crosstabs. If you specify the <code>report</code> option, <code>iecodebook</code> will also create another codebook titled '''"codebook report.xlsx"''', in the same location as the '''harmonization codebook'''. This report [[Data Documentation|documents]] the final state of the dataset for quick reference.
  
 
     . ta survey foreign
 
     . ta survey foreign
Line 178: Line 177:
  
 
== Export ==
 
== Export ==
Finally, '''<code>iecodebook export</code>''' provides a simple way to [[Data Documentation|document]] the current state of a dataset, and prepares a '''trimmed''' version of the dataset for release.  
+
Finally, <code>iecodebook export</code> provides a simple way to [[Data Documentation|document]] the current state of a dataset, and prepares a '''trimmed''' version of the dataset for release.  
 
=== Syntax ===  
 
=== Syntax ===  
The syntax for '''<code>iecodebook export</code>''' is as follows:
+
The syntax for <code>iecodebook export</code> is as follows:
iecodebook export [ ''if'' ] [ ''in'' ] using ''"filename.xlsx"''
+
<syntaxhighlight lang="Stata">iecodebook export [ if ] [ in ] using "filename.xlsx" //
, [replace trim("''filename.do''" ["''filename.do''"] [...])]
+
    , [replace trim("filename.do" ["filename.do"] [...])]</syntaxhighlight>
  
'''Note:''' Given below is an explanation of the options under '''<code>iecodebook export</code>'''.  
+
'''Note:''' Given below is an explanation of the options under <code>iecodebook export</code>.  
 
* '''Basic command:''' The basic command will simply produce a record of the dataset’s contents in a specified location.  
 
* '''Basic command:''' The basic command will simply produce a record of the dataset’s contents in a specified location.  
* '''trim( ):''' If the '''trim( )''' option is specified:
+
* <code>trim()</code>: If the <code>trim()</code> option is specified, <code>iecodebook export</code> will work as described below.
** '''Read do-file:'''  '''<code>iecodebook export</code>''' will first read the contents of the specified '''do-files'''.
+
** '''Read do-file:'''  <code>iecodebook export</code> will first read the contents of the specified '''do-files'''.
 
** '''Drop irrelevant variables:''' It will then drop any variables that do not match the contents of the '''do-file'''.
 
** '''Drop irrelevant variables:''' It will then drop any variables that do not match the contents of the '''do-file'''.
** '''Restrict the dataset.''' It will also restrict the dataset according to '''if''' and '''in'''.
+
** '''Restrict the dataset.''' It will also restrict the dataset according to <code>if</code> and <code>in</code>.
** '''Save results.''' Finally, it will save the results in the same location as the '''codebook''' as a '''.dta file''' with the same name.
+
** '''Save results.''' Finally, it will save the results in the same location as the codebook, in the form of a '''.dta file''' with the same name.
  
 
=== Implementation ===
 
=== Implementation ===
Note that '''trim( )''' is a new option and is still being developed. For example, '''trim( )''' will not correctly '''parse''' code that relies on '''macros''' to select variables. Therefore, you should check that your results [[Reproducible Research|reproduce]] correctly after using this option.  
+
Note that <code>trim()</code> is a new option and is still being developed. For example, <code>trim()</code> will not correctly '''parse''' code that relies on '''macros''' to select variables. Therefore, you should check that your results [[Reproducible Research|reproduce]] correctly after using this option.  
  
Consider the following example to understand how the '''<code>iecodebook export</code>''' subcommand and the '''trim( )''' option will work. Consider a '''do-file''' titled '''"analysis.do"''', which only contains one line of code:  
+
Consider the following example to understand how the <code>iecodebook export</code> subcommand and the <code>trim()</code> option will work. Consider a '''do-file''' titled '''"analysis.do"''', which only contains one line of code:  
sum foreign mpg trunk
+
<syntaxhighlight lang="Stata">sum foreign mpg trunk</syntaxhighlight>
  
 
Along with this, we also have the dataset we used previously, '''"auto.dta"''' dataset. Now we run the following code:
 
Along with this, we also have the dataset we used previously, '''"auto.dta"''' dataset. Now we run the following code:
iecodebook export using "codebook-trim.xlsx" , trim("analysis.do")
+
<syntaxhighlight lang="Stata">iecodebook export using "codebook-trim.xlsx" , trim("analysis.do")</syntaxhighlight>
  
Then this code saves a '''codebook''' called '''"codebook-trim.xlsx"''', and a dataset called '''"codebook-trim.dta"''' in the same location. Since only the variables '''foreign''', '''mpg''', and '''trunk''' are mentioned in the '''do-file''' titled '''"analysis.do"''', both - '''"codebook-trim.xlsx"''' and '''"codebook-trim.dta"''' - will only contain these 3 variables.
+
Then this code saves a codebook called '''"codebook-trim.xlsx"''', and a dataset called '''"codebook-trim.dta"''' in the same location. Since only the variables '''foreign''', '''mpg''', and '''trunk''' are mentioned in the '''do-file''' titled '''"analysis.do"''', both - '''"codebook-trim.xlsx"''' and '''"codebook-trim.dta"''' - will only contain these 3 variables.
  
 
== Related Pages ==
 
== Related Pages ==
 
[[Special:WhatLinksHere/Iecodebook|Click here for pages that link to this topic.]]<br>
 
[[Special:WhatLinksHere/Iecodebook|Click here for pages that link to this topic.]]<br>
This page is part of the topic '''<code>[[iefieldkit]]</code>'''.
+
This page is part of the topic <code>[[iefieldkit]]</code>.
  
 
== Additional Resources ==
 
== Additional Resources ==

Latest revision as of 23:27, 18 November 2020

iecodebook is the final command in the Stata package created by DIME Analytics, iefieldkit. After data collection is complete, iecodebook allows the research team to automatically perform the repetitive steps involved in cleaning data before further analysis. As the name suggests, the iecodebook command is structured around Excel-based codebooks, which allow researchers to perform and document data cleaning tasks in Excel itself, instead of using do-files.

Read First

  • Please refer to Stata coding practices for coding best practices in Stata.
  • iecodebook is part of the package iefieldkit, which has been developed by DIME Analytics.
  • The iecodebook and its subcommands allow the research team to rapidly clean, harmonize, and document datasets using codebooks.
  • Codebooks allow researchers to document the cleaned data in a format that is both human and machine-readable.
  • To install iecodebook and all the commands in the iefieldkit package, type ssc install iefieldkit in Stata.
  • For instructions and available options, type help iecodebook.

Overview

As its name suggests, the iecodebook command creates Excel-based codebooks. The research team can fill these codebooks with data cleaning instructions for Stata. In this way, iecodebook creates a metadata record which is easier to write than a long sequence of data cleaning commands in a do-file. These codebooks in Excel are also easier to read and understand, even if someone does not have knowledge of Stata. There are four subcommands in iecodebook to support its functions:

  • iecodebook apply reads an Excel codebook where the user renames, recodes, and/or labels a large number of variables, and applies these changes to the current dataset.
  • iecodebook append allows two or more datasets to have the same variable names, labels, and value labels. That is, it harmonizes two or more datasets, and then appends them. As you will see, this is different from simply using the append command in Stata.
  • iecodebook export creates an Excel codebook that describes the current dataset. It can also produce an exportable version of the dataset which only contains the variables used in a particular do-file.
  • iecodebook template creates an Excel template that describes the current or targeted dataset(s), and prepares the codebook for the other iecodebook subcommands.

Apply

The most common data cleaning tasks include renaming variables, applying variable and value labels, and recoding values. The iecodebook apply subcommand allows the research team to perform all of these tasks without writing separate lines of code for each task in Stata. The following steps list how the iecodebook apply works.

  1. Create template: iecodebook first converts the dataset into a template in Excel using iecodebook template. In this template, each column describes different aspects of a single variable, including name, label, type, and so on.
  2. Complete template: After this, you can simply fill out the template, which creates the codebook. The codebook lists all the data cleaning tasks that you wish to perform on the dataset.
  3. Apply changes: The iecodebook apply subcommand then reads these commands, and executes them all with just one line of Stata code. The resulting output is a cleaned dataset, along with an easy-to-read record of the cleaning commands you applied.

Syntax

The following line of code creates an apply template with the relevant dataset. The template is named filename.xlsx in this case.

iecodebook template using "filename.xlsx"

The following line of code applies the changes to the dataset. It saves the codebook with the same name, that is, filename.xlsx.

iecodebook apply using "filename.xlsx"
    , [drop] [missingvalues(# "label" [# "label" ...])]

Implementation

The following steps use an example to explain how iecodebook apply works in practice.

Step 1: Load the dataset

First, load the dataset that you want to clean. In this case, the dataset is named "auto.dta".

1sysuse auto.dta , clear

Step 2: Create template

Next, run the following code to create the template codebook, which is named "cleaning.xlsx" in this case.

2iecodebook template using "cleaning.xlsx"

This produces the template codebook in Figure 1, which shows the state of the data before you make changes.

Figure 1: Data cleaning codebook template

Step 3: Complete template

Next, fill-up the following columns in the template to specify the relevant cleaning tasks:

  • name: Fill the name column in the template to specify what the rename command will do to the variables in the dataset. You can use this to rename a variable. For example, in Figure 3, we rename the foreign variable to domestic depending on which of these names is assigned "0" and "1" in the choices sheet (shown in Figure 6).
  • label: Fill the label columns in the template to specify what the label command will do to the variables in the dataset. You can use this to give more information about a variable.
  • choices: Enter a label name in the choices column to apply a particular value label for a variable. Also create the corresponding value label in the choices sheet. Every template already includes a demo yesno label as a guide. For example, in Figure 3, we have applied the yesno value label to the variable with the name domestic, to indicate if a car is domestically made or not. We have also applied the origin value label to the variable with the name foreign. We will also create the origin value label in the choices sheet, for instance by assigning values of "0" to domestic, and "1" to foreign.
  • recode:current: Use the usual syntax (rule) [(rule) ...] in the recode:current column to recode data values. For example, in Figure 3, we use (0=1)(1=0) to indicate that the label for the value of "0" has now been assigned to "1" , and the label for the value of "1" has now been assigned to "0". Using the example above, this means that now foreign has a value of "0", and domestic has a value of "1".

Note: The data types are given for reference only; you cannot use iecodebook to change them. Figure 3 shows how you can make the above changes to the foreign variable.

Figure 2: iecodebook apply template filled out with changes to be applied

Step 4: Apply cleaning commands

Finally, apply the changes using the following command, and save the codebook with the same name as before - "cleaning.xlsx".

3iecodebook apply using "cleaning.xlsx"

Note: Keep the following points in mind when using iecodebook apply.

  • Default: By default, all variables where you do not make changes will be the same as before.
  • Dropping variables: You can also use iecodebook apply to drop variables from the dataset, using the drop option, or using single periods (.).
    • drop: You can simply use the drop option to drop variables from the dataset that have no final variable name under the name column.
    • Single period (.): Alternatively, you can place a single period (.) under the name column to drop variables one by one.
  • missingvalues(): The missingvalues() option allows you to add global missing-value codes to all value labels. For example, if you use extended missing values consistently you can have .a or .n have the same meaning in all responses.
  • Value labels: You will have to manually recreate all value label lists in the choices sheet. However, you can copy-paste data labels from your original dataset to the choices_current sheet.

Append and Harmonize

A common task in data collection is combining two or more sequential rounds of surveys, or combining similar survey instruments that were used in different contexts. This is often a tricky process, and at least one of the datasets might not be correctly updated. In such a case, simply using the append command in Stata will not provide you with the desired structure for your dataset. In such cases, it is possible that certain aspects may not be synchronized or harmonized across the two datasets, such as:

  • Variable names
  • Variable labels (including translations)
  • Value labels
  • Data types

In these cases, iecodebook append offers a quick option to document and resolve these differences across multiple datasets. The following steps list how iecodebook append works.

  1. Create template: Just as in the case of iecodebook apply, use iecodebook template to first convert the dataset into a harmonization template in Excel. In this template, each column describes different aspects of a variable, including name, label, type, and so on. The only difference is that in this case, iecodebook also creates a new variable called survey by default. The value label for this variable will contain the name of the surveys that you specify under the surveys() option for iecodebook template.
  2. Complete template: After this, you can simply fill out the template in Excel. In this template, you can specify the rules to append the datasets, and resolve differences across the two datasets. For instance, you can place certain variables in the same row, and iecodebook append will understand this to mean that we want those variables to have the same values under the name, label and choices columns so that they can append properly.
  3. Append datasets: The iecodebook append subcommand then reads the rules that you specify in the template, and uses them to finally append the datasets. The resulting output is a harmonized dataset with all the differences across the two datasets now resolved.

Syntax

The general syntax of iecodebook template in this case is as follows:

4iecodebook template "filename.dta" "filename.dta" [...] //
5    using "filename.xlsx" //
6    , surveys(Survey1Name Survey2Name [...]) //
7    [generate(varname)] [match]

The following is the syntax to run iecodebook append subcommand based on the rules you specify in the harmonization template:

 8iecodebook append "filename.dta" "filename.dta" [...] //
 9    using "filename.xlsx" //
10    , surveys(Survey1Name Survey2Name [...]) //
11    [generate(varname)] [keepall] [report] [replace] //
12    [missingvalues(# "label" [# "label" ...])]

The following points explain the options that are used with the iecodebook template and iecodebook append subcommands:

  • match: The match option automatically aligns variables from other datasets in the same row if they share a name with a variable in the first dataset. It is optional for the template subcommand only.
  • surveys(): The surveys() option must be used with both subcommands, and the names you specify under this option must be the same for both subcommands. Specify the names of the surveys as a list of single words - (Survey1Name Survey2Name [...]). iecodebook will look for these names in the headers of the codebook. The command will also create a survey variable in the resulting dataset by default. The value label for this variable will contain the name of the surveys that you specify under the surveys() option.
  • generate(): To change the name of the survey variable, use the generate() option in both subcommands.
  • report: The report option exports a codebook with the results of the resulting dataset for quick reference.
  • replace: The replace option allows you to overwrite the existing file which contains the codebook.

Implementation

The following steps show how iecodebook append works in practice.

Step 1: Create two different datasets

First, create two datasets that have similar data but different structures. Run the following code for this.

1 sysuse auto.dta , clear
2 save data1.dta , replace
3 rename price cost
4 rename mpg car_mpg
5    recode foreign (0=1 "Domestic")(1=0 "Foreign") , gen(origin) 
6    drop foreign 
7 save data2.dta , replace

Note: We have used the same dataset, "auto.dta", to create two different datsets, "data1.dta" and "data2.dta"

Step 2: Combine the datasets

Next, combine the datasets to create a harmonization codebook template in Excel using iecodebook template. Name this file "harmonization.xlsx"'. This is shown in Figure 3. Run the following code.

 8 iecodebook template "data1.dta" "data2.dta" //
 9    using "harmonization.xlsx" //
10    , surveys(First Second)

Note: The names of the surveys are First and Second. These names appear in the column names in Figure 3 below as follows - name:First, name:Second, label:First, label:Second, and so on.

Figure 3: iecodebook append harmonization codebook template

If you use the match option, the harmonization template will appear as shown in Figure 4 below. Note the following about the match option:

  • In this case, the variables are ordered according to how they appear in the first dataset, that is, "data1.dta". However, the order of these variables in the underlying dataset does not get affected, it is only for the purpose of the codebook.
  • iecodebook will never reorder variables beyond the functionality of the built-in append subcommand.


Figure 4: iecodebook append harmonization codebook template using the match option

Step 3: Modify the codebook

Next, to resolve the differences between the two datasets - "data1.dta" and "data2.dta" , modify the completed codebook as shown in Figure 5. In order to harmonize the datasets, place variables from different datasets into the same row. This means that for iecodebook append to append properly, make sure that the variables have the same final variable names, labels, and value labels applied to them in the harmonization template. In our example, it means that for the variables that you want to append, ensure that each of them have the same values under name:First and name:Second columns, and so on for the label: and choices: columns.

Figure 5: iecodebook append codebook with harmonization instructions


Note: Keep the following points in mind when modifying the codebook.

  • recode: columns: You will need to handle the recode commands dataset-by-dataset, instead of just re-arranging the variables. Which is why there is one recode: column for each survey (which acts as a source of data), as well as choices_ sheets for reference.
  • Value labels: As with iecodebook apply, you will have to manually recreate the value label lists in the choices sheet. However, you can copy-paste data labels from your original datasets to the choices_First and choices_Second sheets respectively. This is shown in Figure 6 below.


Figure 6: choices sheet in a codebook

Step 4: Append the datasets

Finally, append the harmonized datasets using the following code. Save the codebook with the same name, that is, "harmonization.xlsx" .

11 iecodebook append "data1.dta" "data2.dta" using "harmonization.xlsx"     
12    , clear surveys(First Second)

Note: There are two important differences between the syntax for iecodebook append and iecodebook apply:

  1. Default is to drop: By default, the iecodebook append command will only keep those variables to which you explicitly give final names in the name column. This is to encourage you to manually review each variable.
  2. keepall: You may use the keepall option to retain all variables from all datasets, except the variables you have tagged for deletion by entering a single period (.) in the name column. This allows you to override the default drop option. However, you should still check the final dataset carefully because if you append variables without explicitly reviewing them, it may again cause problems with synchronization.

Output

The combined dataset will yield the following crosstabs. If you specify the report option, iecodebook will also create another codebook titled "codebook report.xlsx", in the same location as the harmonization codebook. This report documents the final state of the dataset for quick reference.

   . ta survey foreign
         Data |        Foreign
       Source |  Domestic    Foreign |     Total
   -----------+----------------------+----------
        First |        52         22 |        74
       Second |        52         22 |        74
   -----------+----------------------+----------
        Total |       104         44 |       148

Export

Finally, iecodebook export provides a simple way to document the current state of a dataset, and prepares a trimmed version of the dataset for release.

Syntax

The syntax for iecodebook export is as follows:

iecodebook export [ if ] [ in ] using "filename.xlsx" //
    , [replace trim("filename.do" ["filename.do"] [...])]

Note: Given below is an explanation of the options under iecodebook export.

  • Basic command: The basic command will simply produce a record of the dataset’s contents in a specified location.
  • trim(): If the trim() option is specified, iecodebook export will work as described below.
    • Read do-file: iecodebook export will first read the contents of the specified do-files.
    • Drop irrelevant variables: It will then drop any variables that do not match the contents of the do-file.
    • Restrict the dataset. It will also restrict the dataset according to if and in.
    • Save results. Finally, it will save the results in the same location as the codebook, in the form of a .dta file with the same name.

Implementation

Note that trim() is a new option and is still being developed. For example, trim() will not correctly parse code that relies on macros to select variables. Therefore, you should check that your results reproduce correctly after using this option.

Consider the following example to understand how the iecodebook export subcommand and the trim() option will work. Consider a do-file titled "analysis.do", which only contains one line of code:

sum foreign mpg trunk

Along with this, we also have the dataset we used previously, "auto.dta" dataset. Now we run the following code:

iecodebook export using "codebook-trim.xlsx" , trim("analysis.do")

Then this code saves a codebook called "codebook-trim.xlsx", and a dataset called "codebook-trim.dta" in the same location. Since only the variables foreign, mpg, and trunk are mentioned in the do-file titled "analysis.do", both - "codebook-trim.xlsx" and "codebook-trim.dta" - will only contain these 3 variables.

Related Pages

Click here for pages that link to this topic.
This page is part of the topic iefieldkit.

Additional Resources