EGAP methods guides

How to contribute.

For now, please make an issue and/or fork and a pull request specifying the methods guide in question.

When you make a pull request with a change in one language, we will try to incorporate those changes in the other languages. If it is easy to make the change in other languages please do so as well.

Style Guide

We use plain R+markdown for these guides. Since they are served in iFrames on http://egap.org links do not work so well. Because of that, we recommend using [Hello, world!](http://example.com/){target="_blank"} when you insert links.

How to make webpages from these files.

Open RStudio. If not already loaded, load methods-guides.Rproj file before proceeding.

In RStudio, click "Knit to HTML".

At the R console do:

library(rmarkdown)
render("nameoffile.Rmd")

Once you have an html file, if you haven't already changed the links to open in a new tab do something like this at the command line to loop through all directories:

for X in */; do cd "$X"; sed -i.bak 's|href="http|target="_blank" href="http|g' *.html; cd ..; done

Or do this in a single directory:

sed -i.bak 's|href="http|target="_blank" href="http|g' *.html

To recreate all of the guides

We have a Makefile so you can type make -n all to see what guides would need to be recompiled (i.e. might haven't been compiled in a while.) And the type make all to recompile them all.

If you have opened the methods-guides.Rproj in Rstudio you might see a "build" tab (near "Environment", "History", etc..) And there is a button called Build All which does the same thing. (NOte for now: This almost works for all guides. Still working on it for some guides.)

Here is a one liner if you've installed the fd utility for OS X using homebrew or on linux:

for X in `fd  Rmd .`;do Rscript -e "rmarkdown::render('$X')"; done

When writing new guides

To ensure that links are opened in a new tab write links like this [Hello, world!](http://example.com/){target="_blank"}