Dimewiki

Difference between revisions of "Iefolder"

Jump to: navigation, search
Line 7: Line 7:


''iefolder'' also makes it easy to add folders as needed to project folders that was initially set up by ''iefolder'' as the project moves forward and need more sub-folders. See more details in the work flow section below.
''iefolder'' also makes it easy to add folders as needed to project folders that was initially set up by ''iefolder'' as the project moves forward and need more sub-folders. See more details in the work flow section below.
=== Intended Work Flow ===
At the start of project, iefolder is used to set up the project folder based on [[DataWork_Folder|DIME's project folder template]]. See the link for a detailed description of the folder structure, this article will focus on how to use the command.
The first time you set up a project folder you use the <code>new project</code> to set up the top folder ''DataWork'' and the main master do-file. For the command to work properly you may not change the name of this folder or do-file. You set the project up like this:
<pre>
global folder "C:\Users\username\DropBox\ProjectABC" //Update this to your folder
iefolder new project, projectfolder("$folder")
</pre>
After you have created the project folder you can use iefolder add the folders to the project folder according to the need of your project. The type of folders you can add is ''unit of observation'' folder, ''round'' foulder and ''subfolder'' folder.
<pre>
global folder "C:\Users\username\DropBox\ProjectABC" //Update this to your folder
//Create a place where to store all time invariant data on households and clinics
iefolder new unitofobs households, projectfolder("$folder")
iefolder new unitofobs clinics, projectfolder("$folder")
//Create a subfolder for all baseline rounds can be organized
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)
</pre>
Note that you do not have to create all these folders as you set up


== Instructions ==
== Instructions ==

Revision as of 13:20, 8 February 2018

iefolder is used to set up standardized project folder structures with master do-files and to add to them as the project expands.

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 iefolder 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

This command is intended to set up folder structure for a new project. The folder structure template used by this command is DIME's folder structure template described in the DataWork folder page. Our strong recommendation is that all organizations should have a standardized folder structure, and that all individual projects should set up their own or someone else's standardized folder structure, but this structure can of course differ in many ways compare to DIME's folder structure. iefolder makes it easy to set up DIME's standardized folder structure in a new project.

iefolder also makes it easy to add folders as needed to project folders that was initially set up by iefolder as the project moves forward and need more sub-folders. See more details in the work flow section below.

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 iefolder 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=4199"