/EMLassemblyline

A workflow and set of functions to make EML using R.

Primary LanguageR

The EML Assembly Line

The Ecological Metadata Language (EML) is a metadata standard developed by the ecological community for persistence, discoverability, and reuse of ecological data. EML facilitates understanding, persistence, and reuse of data. While the highly detailed structure of the EML schema is necessary to meet these ends it confronts the inexperienced data provider with a steep learning curve that few have time to tackle. To lower the bar for data documentation, while still maintaining a high level of metadata detail and quality, we've created the EMLassemblyline R code package. A user friendly workflow helping you craft high quality EML metadata yourself! The assembly line is useful for publishing one-off data packages for submission to a data repository or for providing a foundation to a data package factory.

The EMLassemblyline requires little operational knowledge of the R programming language or technical understanding of the EML schema. All you need is to know your dataset and how it was made, a little patience for following our step by step instructions, and how to enter operate a spread sheet editor. If this is your first time on the assembly line, it may take the better part of a day to become oriented and to produce your first EML metadata file.

Getting started

Contents

Documenation

A schematic representation of the assembly line process.

A list of the EML schema elements that are populated by the assembly line with some notes on the level of detail supplied to these elements.

An example of using the EML assembly line.

R package

EMLassemblyline is a collection of wrapper functions to the EML R package developed by Boettiger et al. (2017). For an understanding of what is going on under the hood of the assembly line, we recommend you first take a look at the EML R package. Once you understand this you will be able to customize the assembly line for your own workflows or become a developer of this project.

The EMLassemblyline R package is available here on GitHub. To install, go to your RStudio Console window and enter these lines of code:

# Install and load devtools
install.packages("devtools")
library(devtools)

# Install and load EMLassemblyline
install_github("EDIorg/EMLassemblyline")
library(EMLassemblyline)

Now reference the documentation listed above to start operating the assembly line.

Running the tests

We have not yet formalized our testing.

Contributing

We welcome contributions of all forms including code, bug reports, and requests for development. Please reference our code conduct and contributing guidelines for submitting pull requrests.

Versioning

We do not yet have any versions available. Stay tuned!

Authors

Several people have participated in this project. View the current list of team members and contributors.

License

This project is licensed under the CC0 1.0 Universal (CC0 1.0) License - see the LICENSE file for details.

Related materials

Learn everything you wanted to know about the Ecological Metadata Language standard.

Reference the community developed best practices for EML content.