README.md

Zoon banner Build Status codecov.io cran version DOI rstudio mirror downloads

zoon is a package for the reproducible and shareable analysis of species distribution models with a focus on the ability to compare between models and diagnostic output of models.

An overview of the project can be found here. There is a blog to keep collaborators up to date with progress. This can be found here

zoon is still being developed. Feel free to clone and use the code, open issues, let us know what you want etc. But don't expect much functionality from the package yet. If you would like to add functionality, please start writing modules!

Basic usage

library(zoon)

# Run a workflow, specifying one module of each type.
work1 <- workflow(occurrence = UKAnophelesPlumbeus,
                  covariate  = UKAir,
                  process    = OneHundredBackground,
                  model      = LogisticRegression,
                  output     = PrintMap)

# Get a list of modules
GetModuleList()

# Get help on a module
ModuleHelp(LogisticRegression)

Installation

zoon is now on CRAN, so you can install the stable(ish) version directly from R with:

install.packages('zoon')

you can also install the most recent development version of the package straight from GitHub using the devtools package:

devtools::install_github("zoonproject/zoon")

Contributing modules

zoon has a modular structure, and we are hoping for user submitted modules. This allows zoon to keep up to date with the fast-moving SDM field in a way a package maintained by a small team of developers can't. Modules are simple R scripts containing a single function and some metadata. They are currently kept here. The inputs and outputs of each module type are controlled. A brief description can be found at the end of the Build a module vignette. The function BuildModule is used to turn a function in an R session into a module.

Please note, zoon is still being developed. We would love you to contribute modules, but can't yet guarantee that there won't be major changes that might break modules. We will try to fix user submitted modules if we break them.

Notes for collaborators

We welcome collaboration and input anyone who'd like to get involved! If you have any comments, suggestions or you spot any bugs or errors, please let us know via the issue tracker. Pull requests are always welcome, though please let us know what you're developing first so we plan how to integrate it into the main package.

We are committed to making zoon an inclusive project that the whole research community can contribute to and benefit from it and ask all contributers (including the zoon development team) to stick to a code of conduct

We are using the Google style guide with the exception that function description goes before the function name, not inside the function definition. We are using roxygen2 to document the package. Try to keep function names as verbs.

Zoon banner



zoonproject/zoon documentation built on Nov. 16, 2018, 5:06 a.m.