Iefolder

Revision as of 17:02, 23 April 2019 by Ppaskov (talk | contribs)
Jump to: navigation, search

iefolder is a Stata command within ietoolkit. It sets up the DataWork folder, a standardized project folder structure for reproducible research. In addition to setting up the DataWork folder, iefolder creates master do-files linking to all main folders in the folder structure. These master do-files are updated whenever more rounds, units of observations, and subfolders are added to the project folder using this command. It is important to run iefolder at the beginning of a research project in order to use the DataWork folder throughout the entire project. This page describes use cases and work flow.

Read First

  • To install all commands in ietoolkit, including iefolder, type ssc install ietoolkit in Stata.
  • To create more subfolders within the DataWork folder as the project moves forward, use the iefolder command in Stata.
  • For instructions on how to use iefolder and for a complete list of available options, type help iefolder in Stata.
  • For more information on the folder structure that iefolder sets up, see DataWork Folder

Instructions

Setting up

To set up the DataWork folder and the main master do-file, use new project. For the command to work properly, do not change the name of this folder or do-file.

global folder "C:\Users\username\DropBox\ProjectABC" //Update this to your folder
iefolder new project, projectfolder("$folder")

Adding folders

To add folders to an already existing DataWork folder, use the subfolder, round, and/or unitofobs options, depending on the folder you wish to create.

Unit of Observation folders provide a place to store master data for different units of observation. This unitofobs option creates a master data folder for each new unit of observation in two places: in the MasterData folder and the Encrypted folder.

global folder "C:\Users\username\DropBox\ProjectABC" //Update this to your folder

//Create a place to store all time invariant data on households and clinics
iefolder new unitofobs households, projectfolder("$folder")
iefolder new unitofobs clinics, projectfolder("$folder")

Round folders are specific to a data collection round (baseline, endline, follow-up etc.). When adding a new round, the round option adds a round folder to the DataWork folder that follows the DataWork Survey Round structure; it contains a Datasets folder, Dofiles folder, Outputs folder, Documentation folder and Questionnaire folder. Each round folder contains a master do-file that references the main folders in the folder structure specific to the round. Whenever you create a new round folder, iefolder creates a partner folder for each round in the Survey Encrypted Data folder.

Subfolders are a single, empty folders within a parent folder. The subfolder option updates the master do-file with a global to the new folder. This is useful if, for example, you collected data on multiple units of observation in a given survey round. For example, a project may have baseline data collection for students, teachers, and schools. In this case, you could use subfolder to create an empty Baseline folder and within the subfolder, use round to create Baseline folders for students, teachers and schools.

//Create a subfolder for all baseline rounds 
iefolder new subfolder baseline, projectfolder("$folder")

//Create a folder for each data collection activity, see that they are organized into the subfolder
iefolder new round farmer_baseline, projectfolder("$folder") subfolder(baseline)
iefolder new round clincs_baseline, projectfolder("$folder") subfolder(baseline)

Note that you do not have to create all these folders at the time when the project folder is set up in the first place. You can add these folders as the need arises throughout the duration of the project. Remember to not change the names of the folders or master do-files that iefolder creates as the command might not work as intended then.

Back to Parent

This article is part of the topic ietoolkit