Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 1.37 KB

README.md

File metadata and controls

46 lines (36 loc) · 1.37 KB
Raw

obisindicators

R package for generating indicators from OBIS

Example Plots

Animated map of OBIS data segemented by decade: decadal_animation

All data from OBIS in one map: all_data

Install

Basic installation is simple:

remotes::install_github("marinebon/obisindicators")

But you will also need to install dependencies. You will need to install RTools and devtools to do this. Once those are installed run the following to complete installation of this package and its dependencies:

devtools::install_local()

Use

library(obisindicators)

Developer Stuff

Setup

You will likely need Rtools to install the dggridr dependency. Rtools is installed separately from R and Rstudio.

devtools::install_local()
testthat::test_local()

Notes on creating vignettes

  • create new vignettes via usethis::use_vignette("new_vignette_name")
  • to pre-build a vignette
    • set chunk's eval is false
    • then put markdown into the vignette to display the output image (or other html)
    • assets go in vignettes or in man/figures [ref)