Dimewiki

Difference between revisions of "Iefolder"

Jump to: navigation, search
(Replaced content with "{{subst:ietoolkit_command}}")
Line 1: Line 1:
<code>iefolder</code> sets up project folders and master do-files according to World Bank DIME's standards. It automates the process of setting up the folders and master do-files  where all the data work will take place in a project folder. The folders set  up will follow DIME's best practices outlined and explained in [[DataWork Folder]]
'''commandName''' is used to [''insert short command description here''].


In addition to setting up the '''DataWork''' folder and its sub-folders, the 
This article is means to describe use cases, work flow and the reasoning used when developing the commands. For instructions on how to use the command specifically in Stata and for a complete list of the options available, see the help files by typing <code>help '''commandName'''</code> in Stata. This command is a part of the package [[Stata_Coding_Practices#ietoolkit|ietoolkit]], to install all the commands in this package including this command, type <code>ssc install ietoolkit</code> in Stata.
command creates master do-files linking to all of these sub-folders. These 
master do-files are updated whenever more subfolders are added using this command.


===itemtypes===
== Intended use cases ==
This command can create either a new DataWork folder or add folders to an 
''Describe use case here''
existing DataWork folder. The existing DataWork folder must have been created  with <code>iefolder</code> for the additions to work. There are two types of folders that can be added to an existing folder, ''round'' and ''untiofobs''.
# round folders :
folders specific to a data collection round, for example, ''Baseline'', ''Endline'', ''Follow Up'' etc. When adding a new round, sub-folders are added to the DataWork  folder in line with the best practice described in [[DataWork_Survey_Round]]. <code>iefolder</code> also creates a master do-file specific for this round with globals referencing the sub-folders specific to this round. <code>iefolder</code> is implemented so that you can keep working for years with your project in between adding folders. The command reads and preserves changes made manually to the DataWork folder and master do-file before making additions when adding a new round.


#unitofobs folders :
=== Intended Work Flow ===
folders specific to a unit of observation, for example the master data set folder. Read more about master data sets and the folder structure in [[Master_Data_Set]]. A master data folder for each new unit of observation is created in two places. Both in the MasterData folder in the DataWork folder, and in the MasterKeyID folder in the encrypted folder.
''Describe work flow here (remove if obvious from use case)''
 
== Instructions ==
These instructions are meant to help you understand how to use the command. For technical instructions on how to implement the command in Stata see the help files by typing <code>help  '''commandName'''</code> in Stata.
 
''Describe best practices related to this command here.''
 
== Reasoning used during development ==
''Describe any non obvious decisions made during development of this command. This can help explain restrictions and requirements''
 
== Back to Parent ==
This article is part of the topic [[Stata_Coding_Practices#ietoolkit|ietoolkit]]
 
[[Category: Stata ]]

Revision as of 15:57, 1 February 2018

commandName is used to [insert short command description here].

This article is means to describe use cases, work flow and the reasoning used when developing the commands. For instructions on how to use the command specifically in Stata and for a complete list of the options available, see the help files by typing help commandName in Stata. This command is a part of the package ietoolkit, to install all the commands in this package including this command, type ssc install ietoolkit in Stata.

Intended use cases

Describe use case here

Intended Work Flow

Describe work flow here (remove if obvious from use case)

Instructions

These instructions are meant to help you understand how to use the command. For technical instructions on how to implement the command in Stata see the help files by typing help commandName in Stata.

Describe best practices related to this command here.

Reasoning used during development

Describe any non obvious decisions made during development of this command. This can help explain restrictions and requirements

Back to Parent

This article is part of the topic ietoolkit

Retrieved from "https://dimewiki.worldbank.org/index.php?title=Iefolder&oldid=4173"