Skip to content
Support Package for Portal Predictions
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
inst/extdata
man
tests
vignettes
.Rbuildignore
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DESCRIPTION
LICENSE
NAMESPACE
NEWS.md
README.md
in_dev.R

README.md

Supporting automated iterative forecasting of Portal rodent populations

Build Status License Lifecycle:maturing Codecov test coverage

Overview

The portalcasting package contains the functions used for continuous analysis and forecasting of Portal rodent populations (code repository, output website, Zenodo archive).

portalcasting's functions are also designed to be portable, allowing users to set up a fully-functional replica repository on a local or remote machine. This facilitates development and testing of new models via a sandbox approach.

Status: Deployed, Active Development

The portalcasting package is deployed for use within the Portal Predictions repository, providing the underlying R code to populate the directory with up-to-date data, analyze the data, produce new forecasts, generate new output figures, and render a new version of the website. All of the code underlying the forecasting functionality has been migrated over from the predictions repository, which contains the code executed by the continuous integration. Having relocated the code here, the portalcasting package is the location for active development of the model set and additional functionality.

The current master branch code is not necessarily always being executed within the predictions repository. This is a desired result of our use of a software container, in the repository, which enables reproducibility. Presently, we use a Docker image of the software environment to create a container for the code. The image update (i.e. the integration of the current master branch of portalcasting into the predictions repository) necessarily lags behind updates to the master branch of portalcasting, although ideally not long behind. The latest image is built using portalcasting v0.8.0.

The API is moderately well defined at this point, but is still evolving.

Installation

You can install the R package from github:

install.packages("devtools")
devtools::install_github("weecology/portalcasting")

Production environment

If you wish to spin up a local container from the Portal Predictions image (to ensure that you are using a copy of the production environment for implementation of the portalcasting pipeline), you can run

sudo docker pull weecology/portal_predictions

from a shell on a computer with Docker installed (Windows users need not include sudo). A tutorial on using the image to spin up a container is forthcoming.

Usage

Get started with the "how to set up a Portal Predictions directory" vignette

If you are interested in adding a model to the preloaded set of models, see the "adding a model" vignette.

Acknowledgements

The motivating study—the Portal Project—has been funded nearly continuously since 1977 by the National Science Foundation, most recently by DEB-1622425 to S. K. M. Ernest. Much of the computational work was supported by the Gordon and Betty Moore Foundation’s Data-Driven Discovery Initiative through Grant GBMF4563 to E. P. White.

We thank Henry Senyondo for help with continuous integration, Heather Bradley for logistical support, John Abatzoglou for assistance with climate forecasts, and James Brown for establishing the Portal Project.

Author Contributions

All authors conceived the ideas, designed methodology, and developed the automated forecasting system. J. L. Simonis led the transition of code from the Portal Predictions repo to portalcasting.

You can’t perform that action at this time.