achubaty / SpaDES.project

Project Templates Using 'SpaDES'

SpaDES.project

Quickly setup 'SpaDES' project directories and add modules using templates.

See package vignettes to get started.

1. Getting started vignette
2. Managing large SpaDES projects
3. Using git and GitHub
4. Using LandR and fireSense

Project types:

• basic
• advanced
• LandR-fS

Website: https://SpaDES.PredictiveEcology.org

Wiki: https://github.com/PredictiveEcology/SpaDES/wiki

Installation

Current stable release

Install from CRAN:

install.packages("SpaDES.project")

Install from GitHub:

#install.packages("devtools")
library("devtools")
install_github("PredictiveEcology/SpaDES.project", dependencies = TRUE) # master

Development version (unstable)

Install from GitHub:

#install.packages("devtools")
library("devtools")
install_github("PredictiveEcology/SpaDES.project", ref = "development", dependencies = TRUE)

Create a new project with several SpaDES modules

This will create a new RStudio project, download 4 modules from their respective GitHub.com repositories, create a control script (e.g., global.R) and finally open that new project in RStudio. The resulting control script that will technically run, but one or more of the modules will likely be missing some input object that are expected. Most likely this will be something like an object called studyArea, which is a polygon with the study area. That control script has numerous comments within it to help get started. It will also deal with installing R packages.

SpaDES.project::newProject("FactorialTesting", 
                           path = "tempdir()", 
                           modules = c("PredictiveEcology/Biomass_speciesFactorial",
                                       "PredictiveEcology/Biomass_speciesParameters@EliotTweaks",
                                       "PredictiveEcology/Biomass_borealDataPrep@development",
                                       "PredictiveEcology/Biomass_core@EliotTweaks"), 
                           overwrite = FALSE)

Contributions

Please see CONTRIBUTING.md for information on how to contribute to this project.