Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/trias-project/checklist-recipe

Template repository for standardizing thematic species checklist data to Darwin Core using R
https://github.com/trias-project/checklist-recipe

darwin-core gbif oscibio r rstats

Last synced: 3 months ago
JSON representation

Template repository for standardizing thematic species checklist data to Darwin Core using R

Awesome Lists containing this project

README

        

# Checklist recipe

> 👩🏻‍🍳 This is a template repository for **standardizing thematic species checklist data to Darwin Core using R**. As a result, the rest of the README is a template as well. To use this repository for your own checklist data, [read the recipe](https://github.com/trias-project/checklist-recipe/wiki). Happy cooking!

## Rationale

This repository contains the functionality to standardize the data of to a [Darwin Core Archive](https://www.gbif.org/darwin-core) that can be harvested by [GBIF](https://www.gbif.org/).

## Workflow

[source data](data/raw) → Darwin Core [mapping script](src/dwc_mapping.Rmd) → generated [Darwin Core files](data/processed)

## Published dataset

* [Dataset on the IPT]()
* [Dataset on GBIF]()

## Repo structure

The repository structure is based on [Cookiecutter Data Science](http://drivendata.github.io/cookiecutter-data-science/) and the [Checklist recipe](https://github.com/trias-project/checklist-recipe). Files and directories indicated with `GENERATED` should not be edited manually.

```
├── README.md : Description of this repository
├── LICENSE : Repository license
├── checklist-recipe.Rproj : RStudio project file
├── .gitignore : Files and directories to be ignored by git

├── src
│ ├── dwc_mapping.Rmd : Darwin Core mapping script
│ ├── _site.yml : Settings to build website in docs/
│ └── index.Rmd : Template for website homepage

├── docs : Repository website GENERATED

└── data
├── raw : Source data, input for mapping script
└── processed : Darwin Core output of mapping script GENERATED
```

## Installation

1. Click on `Use this template` to create a new repository on your account
2. Open the RStudio project file
3. Open the `dwc_mapping.Rmd` [R Markdown file](https://rmarkdown.rstudio.com/) in RStudio
4. Install any required packages
5. Click `Run > Run All` to generate the processed data
6. Alternatively, click `Build > Build website` to generate the processed data and build the website in `docs/` (advanced)

## Contributors

[List of contributors]()

## License

[MIT License](LICENSE) for the code and documentation in this repository. The included data is released under another license.