Skip to content

Commit

Permalink
add GloBI index config; related to globalbioticinteractions/globalbio…
Browse files Browse the repository at this point in the history
  • Loading branch information
Jorrit Poelen committed Oct 7, 2024
1 parent 04076b0 commit aee47c2
Show file tree
Hide file tree
Showing 4 changed files with 411 additions and 71 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/review.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# This workflow will review a GloBI indexed dataset.
# For more information see: https://globalbioticinteractions.org

name: GloBI review by Elton

on:
push:
branches: [ '*' ]
pull_request:
branches: [ '*' ]
schedule:
- cron: "0 0 * * 1"

jobs:
review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up JDK 1.8
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '8'
- name: download review script
run: curl --silent -L "https://raw.githubusercontent.com/globalbioticinteractions/globinizer/master/check-dataset.sh" > check-dataset.sh
- name: download network compiler script
run: |
curl --silent -L "https://raw.githubusercontent.com/globalbioticinteractions/globinizer/master/compile-network.sh" > compile-network.sh
chmod +x compile-network.sh
- name: review dataset
run: bash check-dataset.sh "${GITHUB_REPOSITORY}"
- name: Share review report
uses: actions/upload-artifact@v4
with:
name: review-report
path: |
README.txt
datasets/
index.*
indexed-*
review*
33 changes: 3 additions & 30 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,30 +1,3 @@
# History files
.Rhistory
.Rapp.history
# Session Data files
.RData
# Example code in package build process
*-Ex.R
# Output files from R CMD build
/*.tar.gz
# Output files from R CMD check
/*.Rcheck/
# RStudio files
.Rproj.user/
# produced vignettes
vignettes/*.html
vignettes/*.pdf
# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
.httr-oauth
# knitr and R markdown default cache directories
/*_cache/
/cache/
# Temporary files created by R markdown
*.utf8.md
*.knit.md
#Custom view
.DS_Store
Thumbs.db
OBservData.Rproj
#Embargo Folder
Processing_files/Datasets_Processing/Embargo/
.elton/
add_travis_artifact_upload_keys.sh
datasets/
44 changes: 3 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,5 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7932602.svg)](https://doi.org/10.5281/zenodo.7932602)
[![GloBI Review by Elton](../../actions/workflows/review.yml/badge.svg)](../../actions/workflows/review.yml) [![GloBI](https://api.globalbioticinteractions.org/interaction.svg?accordingTo=globi:ibartomeus/OBservData&refutes=true&refutes=false)](https://globalbioticinteractions.org/?accordingTo=globi:ibartomeus/OBservData)

# Crop Pollination Database

## How to use the database:

The database is stored as three `.csv` files you can find in `Final_Data` folder. Here you will find the latest version (See `News.md`). Stable releases can be found in Zenodo: DOI: [10.5281/zenodo.4311291](https://zenodo.org/badge/latestdoi/240485535)

- `CropPol_field_level_data.csv` contains one row per field and study system with summary values per field incuding field coordinates, pollintor richness, yield, etc...
- `CropPol_sampling_data.csv` contains pollinator sampling data on which pollinators where collected per field.
- `CropPol_data_ownership.csv` contains information on data authors, affiliations and funding.

Please, check Metadata [here](http://htmlpreview.github.io/?https://github.com/ibartomeus/OBservData/blob/master/Metadata/docs/index_Rev.html) and understand the data limitations [here](https://github.com/ibartomeus/OBservData/blob/master/Manuscript/OBSerData_Final.pdf)

If you want to dig into raw data files, all reproducible data and code to build the database is under the `Processing_files` folder.

## How to cite the database:

Please cite CropPol database when the data are used in bulk in publications and cite individual studies when pertinent.

- Version 1.1.1 is published as a Data Paper in Ecology: Allen-Perkins et al. 2022. CropPol: A Dynamic, Open and Global Database on Crop Pollination. Ecology 103(3):e3614. https://doi.org/10.1002/ecy.3614

- Bugs are updated in the third digit (e.g. v1.0.1), new datasets in the second digit (e.g. v1.1.0) and major upgrades in the first digit (e.g. v2.0.0). You can see how to cite more recent versions with updated data and contributing authors in: https://github.com/ibartomeus/OBservData/releases and in Zenodo.

## How to contribute?

We encourage you to add new data to this database. If you are github user, just clone the repo, and follow the instrucions in `Your_new_study` folder. When ready, make us a pull request and we will add the new data.

If you are not familiar with github, don't worry, just [download the template](https://github.com/ibartomeus/OBservData/raw/master/Template/Template_example_V9.ods), fill it up and open an [issue](https://github.com/ibartomeus/OBservData/issues/new?assignees=AlfonsoAllen&labels=New+data&template=new-data.md&title=%5Bdata%5D) to let us know where we can access the template.

This is the workflow for github users (A) and non-users (B).

![](Your_new_study/workflow.jpeg)


## Spotted any error?

Please let us know in an [issue](https://github.com/ibartomeus/OBservData/issues/new?assignees=AlfonsoAllen&labels=bug&template=bug_report.md&title=%5Bbug%5D)

### Thanks to:

We started using livedat **Template Repo** designed to assist in setting up a repository for regularly-updated data. Details in [this PLOS Biology paper](https://doi.org/10.1371/journal.pbio.3000125). Instructions for creating an updating data workflow can be found at this companion website: [UpdatingData.org](https://www.updatingdata.org/).
Configuration to help Global Biotic Interactions (GloBI, https://globalbioticinteractions.org) index:

Allen-Perkins, Alfonso, Magrach, Ainhoa, Dainese, Matteo, Garibaldi, Lucas A., Kleijn, David, Rader, Romina, Reilly, James R., et al. 2022. “ CropPol: A Dynamic, Open and Global Database on Crop Pollination.” Ecology 103(3): e3614. https://doi.org/10.1002/ecy.3614
Loading

0 comments on commit aee47c2

Please sign in to comment.