DOI License: MIT

CRAN_Status_Badge CRAN_Status_Badge_version_last_release

master: Build Status Coverage status

dev: Build Status Coverage status

lifecycle

Github site https://github.com/Exp-Micro-Ecol-Hub/dmdScheme

The R Package

The R package dmdScheme is the base package for all dmdScheme schemes. The metadata scheme used by this package (dmdScheme) in itself is just a template and of no real applicability. It needs to be adjusted to actual needs and uploaded to the site dmdScheme repository so that it can be used.

The definition of the dmdScheme can be found at the dmdScheme repository. The R package provides the functionality to work in R with the scheme, i.e. to enter, validate and export the metadata.

Installation

The recommended way is to install from CRAN the stable released version:

install.packages("dmdScheme")

To install the master branch, the stable branch which will become the new CRAN release, from the dmdScheme repository on github, run

## install the devtools package if not installed yet
# install.packages("devtools")

devtools::install_github("Exp-Micro-Ecol-Hub/dmdScheme", ref = "master", build_opts = NULL)

If you are feelinfg adventourous, want to live at the bleeding edge and can live with non-working features, you can install the dev branch. This branch is not stable and features and functionality can appear or be remioved without prior notice:

## install the devtools package if not installed yet
# install.packages("devtools")

devtools::install_github("Exp-Micro-Ecol-Hub/dmdScheme", ref = "dev", build_opts = NULL)

Other branches are not generally recommended for instalation unless you are developing dmdScheme!

Loading the package

When you load the package, the definition of the scheme is downloaded from the dmdScheme repository installed to a temporary scheme library in a temporary directory for usage in this R session. As this scheme library is styored in a temporary directory, it will be deleted when youu quit your R session and re-downloaded each time you start a new session and load the package. To create a permanent package library you have to create a cache in the user directory. To do this, run

cache(createPermanent = TRUE)

and restart your R session. Noiw the definitions of the installed dmdSchemes will be installed in this user cache and be available permanently. For further info, see the documenatation of the command cache().

Accompagnying documentation (vignettes)

Other Resources

Example scheme

For a workable example with data see the documentation of the emeScheme

Presentations

Outdated Resources (Just for historical reasons)

Presentations