diff --git a/README.md b/README.md index 19e8455..e74bff8 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ Some features of the command might require meta data specific to SurveyCTO, but In this first version, `iefieldkit` performs the following three tasks: * _Before data collection_ , `ietestform` is a compliment to the ODK syntax test on SurveyCTO server as `ietestform` runs tests related to best practices on how to, and how not to use features in the ODK programming language to ensure data quality, especially if the data will be imported to Stata that has other restrictions than ODK syntax. -* _During data collection_, `ieduplicates` and `iecompdup` (both previously released as a part of the package `ietoolkit` but now moved to this package) provide a workflow for detecting and resolving duplicate entries in the dataset, ensuring that the final survey dataset will be a correct record of the survey sample to merge onto the master sampling database. +* _During data collection_, `ieduplicates` and `iecompdup` (both previously released as a part of the package `ietoolkit` but now moved to this package) provide a workflow for detecting and resolving duplicate entries in the dataset, ensuring that the final survey dataset will be a correct record of the survey sample to merge onto the +sampling database. * _After data collection_, the `iecodebook` commands provide a workflow for rapidly cleaning, harmonizing, and documenting datasets. `iecodebook` uses input specified in an Excel sheet, which provides a much more well-structured and easy to follow (especially for non-technical users) overview that the same operations written directly to a dofile. ## More on installation @@ -32,7 +33,7 @@ The vast majority of users should install the command by typing `ssc install ief ### Installing unpublished version of this package - If you want a yet to be published version of **iefieldkit** then you can use the code below. The code below installs the version currently in the `master` branch, but replace _master_ in the URL below with the name of the branch you want to install from. You can also install older version of **iefieldkit** like this but it will only go back to January 2019 when we set up this method of installing the package. + If you want a yet to be published version of **iefieldkit** then you can use the code below. The code below installs the version currently in the `main` branch, but replace _main_ in the URL below with the name of the branch you want to install from. You can also install older version of **iefieldkit** like this but it will only go back to January 2019 when we set up this method of installing the package. ``` **When working with multiple version from different sources, @@ -41,7 +42,7 @@ The vast majority of users should install the command by typing `ssc install ief cap ado uninstall iefieldkit *Install iefieldkit directly from the repository - net install iefieldkit , from("https://raw.githubusercontent.com/worldbank/iefieldkit/master/src") replace + net install iefieldkit , from("https://raw.githubusercontent.com/worldbank/iefieldkit/main/src") replace ``` If you are using a work computer where you are not permitted to make a `net` call to the internet from Stata, then you can do the following. Download the files from this repository by clicking the green _Clone or download_ button. Click the `<> code` tab if you do not see that button. Unzip the folders on your computer and change the URL in `from()` in the code above to the location of the _src_ folder where you unzipped the files on your computer. @@ -60,6 +61,6 @@ After you have done the contributions or testing that you intended to do, you ha ### Errors after installing from multiple sources -If you have installed a package from multiple sources, then you might get the error below. If you get that error, follow the instructions [here](https://github.com/worldbank/iefieldkit/blob/master/admin/multiple-package-source-error.md). +If you have installed a package from multiple sources, then you might get the error below. If you get that error, follow the instructions [here](https://github.com/worldbank/iefieldkit/blob/main/admin/multiple-package-source-error.md). ![multiple-package-source-error](https://user-images.githubusercontent.com/15911801/52809664-cadc3900-305e-11e9-863f-bff31f07a9ef.png)