Merge branch 'develop' into main

.gitignore

@@ -35,6 +35,7 @@
 # Keep markdown files used for documentation on GitHub
 !README.md
 !CONTRIBUTING.md
+!LICENSE
 
 # Keep documentation files for GitHub Sites
 !/**/*.yml
@@ -56,18 +57,25 @@
 !/**/*.do
 !/**/*.ado
 
-# More
-!/**/*.sh
-!/**/*.bib
-!/diagrams/*.png
-
 # R
 !/**/*.R
+!/**/*.RProj
+!/**/*.Rmd
+# Explicitly ignore R project user files
+.Rproj.user
+
+#Bookdown formatting
+!/**/*.js
+!/**/*.css
+_book/
+# explicitly include the template doc needed for foramtting
+!/**/template.docx
 
 # LaTeX
 !/**/*.tex
 !/**/*.cls
 !/**/*.def
+!/**/*.bib
 
 # Python
 !/**/*.py
@@ -78,9 +86,17 @@
 # Markdown
 !/**/*.md
 
-# Unignore the pdf file for the io page
+# Other util formats
+!/**/*.sh
+!/**/*.yml
+
+# Unignore the images in book and pdf file for the io page
+!/**/img/*.png
+!/**/img/*.jpg
+!/**/examples/*.png
 !/**/mkdocs/docs/bookpdf/*.pdf
 
+
 #######################
 # Include some additional file formats in any output folder. You might have
 # to change the name of the Output folder to whatever it is called in your

.travis.yml

@@ -0,0 +1,16 @@
+language: r
+cache: packages
+pandoc_version: 2.9.2.1
+
+addons:
+  apt:
+    packages:
+    - ghostscript
+
+before_script:
+  - chmod +x ./_build.sh
+  - chmod +x ./_deploy.sh
+
+script:
+  - ./_build.sh
+  - ./_deploy.sh

CONTRIBUTING.md

@@ -1,33 +1,68 @@
-# How to give feedback
-First off, thank you for considering giving feedback or contributing to **Data for Development Impact**.
-Any and all feedback to refine this book further or to make this text as comprehensive as possible is appreciated. Following these
-guidelines helps communicate any errors we may have overlooked, any concepts that may seem little vague or difficult to comprehend or any topics that we have missed to include.
-
-If you are familiar with how GitHub works, please feel free to submit issues for any section you don't understand or
-submit a pull request with any additions you want to make.
-
-## Feedback through Email
-While our preference is to receive feedback through GitHub you are always welcome to submit your feedback via our email [[email protected]](mailto:[email protected])
-
-## Feedback through GitHub
-If you notice any errors in text or if you need further clarification for any sentence/concept/section that you think is not
-exhaustively dealt within the book, you can do so by creating an *issue*. You can read issues submitted by other users or create a new issue [here](https://github.com/worldbank/dime-data-handbook/issues).
-
-For example, if you think the example the authors have used to explain a particular research design is too convoluted to understand,
-creating an issue is useful for you to provide us the feedback that we should use a **simpler example** to explain the research design.
-Please read already existing issues to check whether someone else has made the same suggestion or reported the same error 
-before creating a new issue.
-
-### GitHub Issue Submission Format
-For us to be able to search through the feedback we will organize all issues in a specific format. **If you do not know how to follow all steps in the bullet point below, then please feel free to post the issue anyways, but we will edit the issue so that it follows our format**.
-
-1. Go to [the issues tab](https://github.com/worldbank/dime-data-handbook/issues) on the D4DI repository.
-1. Search the already posted issues to see if the feedback you are about to give is already posted,
-1. If your feedback has not already been brought up, please press the green *New Issue* button to post a new issue.
-1. Write your title on the format **`Ch #: description`** where _#_ is the chapter number and _description_ is a **short** description of the issue, and apply the corresponding chapter label
-1. Please link in the issue to the file in the repo you are commenting on. If you are referencing a specific line please either link to the specific line in the repo or just link to the file and specify the row number you are referencing
-
-### Pull Request Process
-1. Fork this repository if you want to make your contributions directly in the files.
-2. Make your edits in the `develop` branch in your fork and then create your pull request towards the `worldbank/d4di`:`develop` branch. We do not accept pull requests towards the `master` branch
-3. The Repo Maintainer for `worldbank/d4di` will review the pull request and provide comments if necessary.
+# How to make direct contributions to this handbook
+
+This book is written in "_bookdown_" in R.
+You do not need to have R/RStudio and _bookdown_ installed
+to make contributions to the book (see part 1 below),
+but you will need that to compile the book (see part 2 below).
+
+## Part 1 - Contribute directly to the _bookdown_ files
+
+Each chapter is written in R markdown files (`.Rmd`).
+The `.Rmd` files for chapters are stored in the folder `chapter/`
+and the files for appendices etc. are in the folder `auxiliary/`.
+You can find a cheat sheet for `.Rmd` syntax here
+: https://rstudio.com/resources/cheatsheets/
+(but you need to scroll down to find the R Markdown cheat sheet).
+
+If you have write access to this repo,
+create a branch from the `develop` branch (not from `master`)
+and make your edits to that branch.
+If you do not have write access,
+then create a fork of this repo and make your edits in your fork.
+Make them either in `develop` in your fork,
+or in a branch that you create from `develop` in your fork.
+You can make your edits in any text editor or on GitHub.com.
+
+We do not require that you compile the book before submitting a PR,
+but we very much appreciate if you do so
+to test that there is no _bookdown_ bugs.
+This will speed up the processing of us accepting your suggested edit.
+
+## Part 2 - Compiling the _bookdown_ files into the e-book
+
+#### Bookdown step 1 - Clone this repository
+
+To compile this e-book,
+you must start by cloning this `dime-data-handbook` repository.
+
+#### Bookdown step 2 - Install R and RStuido
+
+You need to install both R and RStudio.
+Both software can be self-installed on World Bank computers
+using the "Software Center" (search the Windows menu).
+If you do are not using a World Bank computer,
+then you can install R Studio Desktop
+[here](https://rstudio.com/products/rstudio/download/)
+(these instructions covers how to install both R and RStudio).
+
+#### Bookdown step 3 - Install `bookdown` package
+Open RStudio and in the console window install _bookdown_ using `install.packages("bookdown")`
+
+#### Bookdown step 4 - Open DRiP R project
+
+In the `dime-data-handbook` there is a file called `drip.Rproj`.
+Use RStudio to open this file.
+You open the R project file in RStuido in the "File" menu
+and then select "open project".
+Navigate to and open the `drip.Rproj` file.
+
+#### Bookdown step 4 - Compiling the book
+
+In the same window as your "Environment" window, select the "Build" tab.
+In the menu below these tabs click "Build Book" to compile the book.
+This can take up to ten minutes,
+especially if it is the first time you compile the book.
+
+## Part 3 - Updating the e-book on the GitHub page
+
+This step will only be done by the authors. Instructions to come.

README.md

@@ -1,4 +1,4 @@
-# The DIME Analytics Data Handbook
+# Development Research in Practice
 
 Development Research in Practice: The DIME Analytics Data Handbook.
 This book is intended to serve as an introduction to the primary tasks
@@ -7,17 +7,56 @@ to data collection to data analysis to publication.
 It serves as a companion to the [DIME Wiki](https://dimewiki.worldbank.org)
 and is produced by [DIME Analytics](https://www.worldbank.org/en/research/dime/data-and-analytics).
 
-You can download a pdf-version of a the book for free [here](https://worldbank.github.com/dime-data-handbook).
+## Free e-version
 
-## Contributing
+You can read a free e-version of a the book  [here](https://worldbank.github.io/dime-data-handbook).
 
-If you want to read and/or edit the content of this book, 
-or if you want to render the `.tex` code to a `.pdf` file for easier reading, 
-then clone this repository and open the `/manuscript/manuscript.tex` file in a _LaTeX_ editor of your choice.
+## Feedback
 
-You wont find the actual content of the book in the `/manuscript/manuscript.tex` file 
-as it is a master file that loads the chapter `.tex` files for each chapter in this book. 
-If you want to read and edit any of the content for any chapter, 
-then open the `/manuscript/manuscript.tex` file 
-to find the file path to the chapter `.tex` file for the chapter you are looking for. 
-Then open that chapter's `.tex` file and make your edits there.
+First off, thank you for considering giving feedback to *Development Research in Practice*.
+There are three ways you can provide feedback to this book.
+You can make direct contributions in this repository,
+you can open an issue in this repository,
+or you can send us an email if you are not familiar with GitHub.
+
+Any and all feedback to refine this book further or
+to make this text as comprehensive as possible is appreciated.
+Following these guidelines helps communicate any errors we may have overlooked,
+any concepts that may seem little vague
+or difficult to comprehend or any topics that we have missed to include.
+
+### Feedback through contributing to the this repo
+
+A direct edit to the file is best suited if you see a typo
+or something similar that has an obvious solution.
+If the solution to your feedback is not straightforward,
+then please open a GitHub issue instead where we can discuss the most appropriate action.
+See the [CONTRIBUTING](https://github.com/worldbank/dime-data-handbook/blob/bookdown-contribution/CONTRIBUTING.md)
+file for instructions on how to make a direct edit.
+
+### Feedback through a GitHub "issue"
+
+While GitHub use the word "issue" for feedback and suggestions,
+you can open up a GitHub issue for any type of feedback.
+All we are asking you to do is to read already existing issues
+to avoid duplicated issues
+(feel free to add to a similar issues instead of creating a similar one)
+and to follow the instructions below as best as you can.
+Please submit your issue even if not all parts of these instructions make sense,
+but we might re-format your issue to make it fit our standardized format.
+
+1. Go to [the issues tab](https://github.com/worldbank/dime-data-handbook/issues) on this repository.
+1. Search the already posted issues to see if the feedback you are about to give is already posted,
+1. If your feedback has not already been brought up,
+please press the green *New Issue* button to post a new issue.
+1. Write your title on the format **`Ch #: description`**
+where _#_ is the chapter number and
+_description_ is a **short** description of the issue
+1. Please link in the issue to the file in the repo you are commenting on.
+If you are referencing a specific line please either link to the specific line in the repo
+or just link to the file and specify the row number you are referencing
+
+#### Feedback through Email
+While our preference is to receive feedback through GitHub
+you are always welcome to submit your feedback via our
+email [[email protected]](mailto:[email protected])

_bookdown.yml

@@ -0,0 +1,28 @@
+book_filename: "drip"
+language:
+  ui:
+    chapter_name: "Chapter "
+delete_merged_file: true
+
+rmd_files: [
+  "index.Rmd",
+  "auxiliary/foreword.Rmd",
+  "auxiliary/acknowledgements.Rmd",
+  "auxiliary/authors.Rmd",
+  "auxiliary/contributing.Rmd",
+  "auxiliary/abbreviations.Rmd",
+  "chapters/introduction.Rmd",
+  "chapters/1-reproducibility.Rmd",
+  "chapters/2-collaboration.Rmd",
+  "chapters/3-measurement.Rmd",
+  "chapters/4-acquisition.Rmd",
+  "chapters/5-processing.Rmd",
+  "chapters/6-analysis.Rmd",
+  "chapters/7-publication.Rmd",
+  "chapters/conclusion.Rmd",
+  "auxiliary/appendix.Rmd",
+  "auxiliary/stata-guide.Rmd",
+  "auxiliary/dime-analytics-resources.Rmd",
+  "auxiliary/research-design.Rmd",
+  "auxiliary/bibliography.Rmd"
+]

_output.yml

@@ -0,0 +1,20 @@
+bookdown::gitbook:
+  includes:
+  split_bib: FALSE
+  highlight: null
+  css: style.css
+  config:
+    toc:
+      collapse: section
+      before: |
+        <li><a href="./">Development Research in Practice <br> The DIME Analytics Data Handbook</a></li>
+    download: ["pdf"]
+    sharing:
+      facebook: yes
+      github: yes
+      twitter: yes
+      linkedin: yes
+      weibo: no
+      instapaper: no
+      vk: no
+word_document: default

auxiliary/abbreviations.Rmd

@@ -0,0 +1,77 @@
+# Abbreviations {-}
+
+**3ie** - International Initiative for Impact Evaluation
+
+**AEA** – American Economic Association
+
+**API** – application programming interface
+
+**ATE** – average treatment effect
+
+**AWS** – Amazon Web Services
+
+**CAPI** – computer-assisted personal interviewing
+
+**CSL** – Citation Styles Library
+
+**DIME** – Development Impact Evaluation
+
+**DOI** – Digital object identifier
+
+**EGAP** – Evidence in Governance and Politics
+
+**EPS** – encapsulated PostScript
+
+**FDE** - full disk encryption
+
+**FSE** - file system encryption
+
+**GPS** – global positioning system
+
+**HFC** – High-Frequency Checks
+
+**IAT** – implicit association test
+
+**ID** – identifier or identification
+
+**IPA** – Innovations for Poverty Action
+
+**IRB** – Institutional Review Board
+
+**IV** – Instrumental Variables
+
+**J-PAL** – Abdul Latif Jameel Poverty Action Lab
+
+**MDE** – Minimum Detectable Effect
+
+**MSIE** – Manage Successful Impact Evaluations
+
+**MSIES** – Manage Successful Impact Evaluation Surveys
+
+**ODK** – Open Data Kit
+
+**OLS** – Ordinary Least Squares
+
+**OSF** – Open Science Framework
+
+**PAP** – preanalysis plan
+
+**PDF** – portable document format
+
+**PII** – Personally-Identifying Information
+
+**PNG** – portable network graphic
+
+**RCT** – Randomized Control Trial
+
+**RD** – Regression Discontinuity
+
+**RIDIE** – Registry for International Development Impact Evaluations
+
+**SSC** – Statistical Software Components
+
+**URL** - Uniform Resource Locator
+
+**USB** – universal serial bus
+
+**VPN** - Virtual Private Network