Contribute

Carob is an open-source community project to standardize and compile agricultural research data. You are invited to contribute to Carob by contributing R scripts for datasets of interest, or by improving existing scripts. All scripts are available on github (in the scripts folder).

To contribute you can follow these steps

1. Install the current version of R and git. You can also install R-Studio.

2. In R, install the “carobiner” package with remotes::install_github("reagro/carobiner") (you may need to first run install.packages("remotes")).

3. fork the Carob repo to your github account.

4. clone the forked repo to your computer.

5. create a new R script, or make the changes to an existing script. See this example and the guidelines.

6. check your work by running carobiner::run_carob() for the new or changed R script.

7. sync the forked repo with main repo in reagro/carob such that your fork is not behind.

8. add and/or commit these changes to the forked repo on your github account.

9. push your changes to the forked repo on your github account.

10. create a pull request to integrate your changes into the main repo. Keep pull requests simple. They should normally consist of only one file at a time.

If you are not familiar with these procedures you can try to follow these instructions.

If you find this procedure too daunting we can also try to work with you in other ways. You can drop us an email at carob.data@gmail.com, or raise an issue on github.

You can discover new data sets with the Gardian search engine. You can also look at our to-do list for ideas. You can check our done list to make sure you do not work on a dataset that has already been processed). But since there can be a delay in updating what is shown here, before you start working on a dataset, you should check with carobiner::on_github if it has already been done (and has been added to the github repo). You can also help fix some of the remaining issues.