Merge pull request #365 from worldbank/dev

Merge adodown setup to main

.github/workflows/build_adodown_site.yaml

@@ -0,0 +1,71 @@
+on:
+  push:
+    branches: [main, dev]
+
+name: Build Site
+
+jobs:
+  adodownr:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+
+      - name: Checkout project
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+
+      - name: Setup R
+        uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - name: Install Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: 1.0.37
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get install -y make libcurl4-openssl-dev libssl-dev libfontconfig1-dev libfreetype6-dev libfribidi-dev libharfbuzz-dev libjpeg-dev libpng-dev libtiff-dev libicu-dev pandoc libxml2-dev libgit2-dev libssh2-1-dev zlib1g-dev git
+
+      - name: Install devtools
+        run: install.packages("devtools")
+        shell: Rscript {0}
+
+      - name: Install adodownr
+        run: devtools::install_github("lsms-worldbank/adodownr")
+        shell: Rscript {0}
+
+      - name: Install here
+        run: install.packages("here")
+        shell: Rscript {0}
+
+      - name: Build site
+        run: adodownr::build_site(pkg_dir = here::here(), site_dir = here::here())
+        shell: Rscript {0}
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./docs
+
+  deploy:
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    runs-on: ubuntu-latest
+    needs: adodownr
+    steps:
+        - name: Deploy to GitHub Pages
+          id: deployment
+          uses: actions/deploy-pages@v2

.gitignore

@@ -1,7 +1,7 @@
 ########################################################################
 #
-# This .gitignore file is based on DIME's template
-# https://github.com/worldbank/DIMEwiki/tree/master/Topics/GitHub
+# Created using adodown https://lsms-worldbank.github.io/adodown/, based on DIME .gitignore template:
+# https://github.com/worldbank/dime-github-trainings/tree/main/GitHub-resources/DIME-GitHub-Templates
 #
 ########################################################################
 
@@ -17,13 +17,18 @@
 # These files include GitHub settings
 !.gitignore
 !.gitattributes
-#.io page
-_config.yml
+!.github/**/*.yaml
+
+# Git placeholder file (to commit empty folders)
+!/**/*.gitkeep
 
 # Keep markdown files used for documentation on GitHub
 !README.md
 !CONTRIBUTING.md
-!LICENSE
+!LICENSE*
+
+* Unignore reproot files
+!reproot*.yaml
 
 #######################
 # For performance reasons, if a folder is already ignored, then
@@ -35,39 +40,28 @@ _config.yml
 
 #######################
 # The following file types are code that should always be
-# included no matter where in the DataWork folder they are
-# located unless that folder is explicitly ignored. See example
-# with EncryptedData folder below.
+# included no matter where in the repository folder they are
+# located unless you explicitly ignore that folder
 
 # Stata
 !/**/*.do
 !/**/*.ado
-!/**/*.sthlp
-!/**/*.stpr
-
-# R
-!/**/*.R
-
-# Outputs
-!/**/*.tex
-!/**/*.csv
-
-# Python
-!/**/*.py
-
-# Matlab
-!/**/*.m
+!/**/sthlp/*.sthlp
+!src/stata.toc
+!src/*.pkg
 
-# Markdown
+# Markdown and web docs files
 !/**/*.md
+!src/dev/**/*.png
+!src/dev/**/*.css
 
-# The folder test/ is used for peoples individual testing,
-# this is different from the test scripts in the folder run/
-test/
+####################################
+# Ignore ssc outputs
+src/dev/ssc
 
-###########
-# Outputs in the run/outputs folder
-!/**/outputs/**/*.csv
+# Ignore test inputs and outputs
+src/tests/**/inputs/
+src/tests/**/outputs/
 
-# ignore all iegitaddmd output, results tested with checksums
-/**/iegitaddmd/outputs/
+* Ignore the local dev env set up by repado
+src/tests/dev-env/

README.md

@@ -1,6 +1,26 @@
 **ietoolkit - Stata Commands for Impact Evaluations**
 =====
 
+### Content
+
+### **Content**
+**ietoolkit** provides a set of commands that address different aspects of data management and data analysis in relation to Impact Evaluations. The list of commands will be extended continuously, and suggestions for new commands are greatly appreciated. Some of the commands are related to standardized best practices developed at DIME (The World Bank’s unit for Impact Evaluations). For these commands, the corresponding help files provide justifications for the standardized best practices applied.
+
+
+| Command | Description |
+| --- | --- |
+| [iebaltab](https://worldbank.github.io/ietoolkit/reference/iebaltab.html) | Produces balance tables with multiple groups or treatment arms |
+| [ieboilstart](https://worldbank.github.io/ietoolkit/reference/ieboilstart.html) | Applies best practices for collaboration and reproducibility within a project |
+| [ieddtab](https://worldbank.github.io/ietoolkit/reference/ieddtab.html) | This command runs a Diff-in-Diff regression and displays the baseline values, the two 1st differences and the 2nd difference |
+| [iedropone](https://worldbank.github.io/ietoolkit/reference/iedropone.html) | An extension of the command `drop` with features preventing additional observations are unintentionally dropped |
+| [iefolder](https://worldbank.github.io/ietoolkit/reference/iefolder.html) | Sets up project folders and master do-files according to World Bank DIME's standards |
+| [iegitaddmd](https://worldbank.github.io/ietoolkit/reference/iegitaddmd.html) | Creates a placeholder file in subfolders of a GitHub repository folder, which allows committing folder structures with empty folders |
+| [iegraph](https://worldbank.github.io/ietoolkit/reference/iegraph.html) | Generates graphs based on regressions with treatment dummies common in impact evaluations |
+| [iekdensity](https://worldbank.github.io/ietoolkit/reference/iekdensity.html) |  This command plots univariate kernel density estimates by treatment assignment |
+| [iematch](https://worldbank.github.io/ietoolkit/reference/iematch.html) | Matching base observations towards target observations using on a single continuous variable |
+| [iesave](https://worldbank.github.io/ietoolkit/reference/iesave.html) | Applies best practices before saving data, with option to save meta data report about the data saved |
+| [ietoolkit](https://worldbank.github.io/ietoolkit/reference/ietoolkit.html) | Returns information on the version of `ietoolkit` installed |
+
 ### **Install and Update**
 
 #### Installing published versions of `ietoolkit`
@@ -30,19 +50,6 @@ An easy but still very efficient way to provide any feedback on these commands i
 
 While we have a slight preference for receiving feedback here on GitHub, you are still very welcome to send a regular email with your feedback to [[email protected]](mailto:[email protected]).
 
-### **Content**
-**ietoolkit** provides a set of commands that address different aspects of data management and data analysis in relation to Impact Evaluations. The list of commands will be extended continuously, and suggestions for new commands are greatly appreciated. Some of the commands are related to standardized best practices developed at DIME (The World Bank’s unit for Impact Evaluations). For these commands, the corresponding help files provide justifications for the standardized best practices applied.
-
- - **ietoolkit** returns meta info on the version of _ietoolkit_ installed. Can be used to ensure that the team uses the same version.
- - **iebaltab** is a tool for multiple treatment arm balance tables
- - **ieddtab** is a tool for difference-in-difference regression tables
- - **ieboilstart** standardizes the boilerplate code at the top of all do-files
- - **iefolder** sets up project folders and master do-files according to DIME's recommended folder structure
- - **iegitaddmd** adds placeholder README.md files to all empty subfolders allowing them to be synced on GitHub
- - **iematch** is an algorithm for matching observations in one group to the "most similar" observations in another group
- - **iegraph** produces graphs of estimation results in common impact evaluation regression models
- - **iedropone** drops observations and controls that the correct number was dropped
- - **ieboilsave** performs checks before saving a data set
 
 ### **Contributions**
 If you are not familiar with GitHub see the **Bug reports and feature requests** section above for a less technical but still very helpful way to contribute to **ietoolkit**.