Skip to content

Home

Jump to bottom
rsandino edited this page Jan 15, 2020 · 35 revisions

Welcome to the high-frequency-checks wiki! These Stata templates are designed and maintained by the Research & Knowledge Management team at Innovations for Poverty Action (IPA). They are intended for use by IPA Staff and designed for population-based survey research and randomized impact evaluations. For help implementing the templates or if you'd like to contribute to on-going development, please contact [email protected].

Resources

Jump to: Software Requirements - Installation - Getting Started - Contributing

Software Requirements

The high-frequency-checks templates make extensive use of Stata's excellent Excel modules in order to create output files that are easy to use and disseminate. Unfortunately, these features are only available as of Stata 14.0 or later. Therefore, the user must have Stata 14.0 or later installed on their machine prior to running the high-frequency-checks templates. IPA employees with older versions of Stata should contact IT for access to a newer version.

Installation

Download the latest version of high-frequency-checks from the release page.

The high-frequency-checks templates rely on a series of user-written Stata commands. For convenience, these commands have been wrapped up in a single Stata package (ipacheck) located in the ado folder. To install, open Stata and enter one of the following:

/* option #1 - command line install */
net install ipacheck, all replace from("C:/directory/to/ado/")

/* option #2 - GUI */
net from "C:/directory/to/ado/"

Note: you will need to replace "C:/directory/to/ado" with the path to the ado folder in the high-frequency-check folder.

The templates also rely on two other IPA Stata commands: cfout and readreplace. These can be installed in the Stata command window using ssc, i.e.

ssc install cfout
ssc install readreplace

Getting Started

  • ado - this folder contains Stata commands source code
  • docs - this folder contains software documentation
  • exercise - this folder contains an example exercise
  • xlsx - this folder contains blank xlsx forms with HFC formatting
  • master_check.do
  • hfc_inputs.xlsx
  • hfc_enumerators.xlsx
  • hfc_replacements.xlsx
  • hfc_outputs.xlsx
doedit master_check.do
do master_check.do

Contributing

If you'd like to contribute to the development of the high-frequency-checks repository, contact [email protected] to obtain the proper privileges.

To clone the repository to your local directory, open a terminal window and enter the following:

git clone https://github.com/PovertyAction/high-frequency-checks.git

Note: you must have the git version control system software installed on your machine.

To begin development you must first checkout your own branch of the repository. A branch is a separate instance of the code source where you can edit without affecting the master. To learn more about branching see here. To checkout a branch type the following in the terminal from the high-frequency-check directory.

git checkout -b yourbranchname

It helps to use an expressive branch name so people will understand what changes you are working on. For instance, if the purpose of the development is to fix issue #5 you might name your branch fix5.

high frequency checks

Help

Clone this wiki locally