Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.

Travis-CI Build Status

TERRA REF Documentation

Overview

In this repository is an extensive set of materials for how to use TERRA REF data and software. The best place to start is the TERRA REF tutorials website. We used bookdown to create the website, and relevant files include _bookdown.yml, index.Rmd, and all of the vignettes.

Tutorials on the website come from the more extensive tutorials in the traits, sensors, and plantcv folders. Notes from walkthroughs of TERRA REF data use are in videos.

These are intended to cover diverse use cases, and you will find information about accessing data from web interfaces but the primary focus is on accessing data using R, Python, SQL, and REST APIs. These are intended to provide quick-start introductions to access data along with computing environments required for further exploration. They are not intended to teach analyses, although some illustrative visualizations and statistical models are provided.

This is a work in progress for an open source community that welcomes contributions in many forms. Please feel welcome to ask questions, provide suggestions, or share analyses that may be of interest to others.

How to contribute

We welcome suggestions and edits from all users. Feel free to create a GitHub issue detailing possible improvements.

If you would like to make changes yourself, fork this repository, make changes on a branch, and submit a pull request. We are happy to help with this process.

There are two ways to preview your changes as you make them. The first is by running the following on the command line from within the forked repository folder:

Rscript -e 'bookdown::render_book("index.Rmd")'

The output will be in the docs folder.

The second way to preview changes is using the Docker container. This requires installing Docker on your computer:

Build the image:

docker build -t terraref-tutorials:local .

Run the container:

docker run --rm -p 3000:3000 --name tutorial-preview terraref-tutorials:local

This will generate the documentation and start a local web server to preview your changes. Open the preview URL in your browser: http://localhost:3000/

Run docker kill tutorial-preview to kill the web server container.