Database plugins for Floralink

Database plugin library for using using different data sources with Floralink Core. These contain only databases and metadata. For statistical operations with Floralink Core, use a corresponding plugin from @floralink/plugins.

• Database plugins for Floralink
• General usage
• Database plugins in this library
  • Taxon reference data
  • Taxon specific data
  • Occurrence data
• Developing a local database plugin
  • File structure
  • index.js

General usage

You can add database plugins to your project by using the @floralink/databases npm package:

$ npm install @floralink/plugins

Then, in your project:

import * as floralink from "@floralink/core";
import { mytaxonreferencedatabase } from "@floralink/plugins";

floralink.initializeDatabase(mytaxonreferencedatabase);

// example for taxon reference data
const myTaxonData = floralink.getTaxonDataByID(
  taxonIDs,
  "mytaxonreferencedatabase"
);

Database plugins in this library

Taxon reference data

| Name | Description | Data origin | Data source | | ---------------------------------------- | ---------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------- | | germansl | Taxon reference for plants, mosses, algae and lichens in Germany | local | GermanSL v1.5.1, a taxon reference list for occurrence databases in Germany |

Taxon specific data

| Name | Description | Data origin | Data source | | ------------------------------------------------------------- | ------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------- | | ellenberg | Ellenberg indicator values (1991) | local | GermanSL v1.5.1 | | fukarekhenker | N, F and T status described by Fukarek & Henker (2006) | local | GermanSL v1.5.1 | | rotelistemv (experimental) | Red list classifications for vascular plants in Mecklenburg-Vorpommern, Germany | local | GermanSL v1.5.1 |

Occurrence data

| Name | Data origin | Data source | | ------------------------------------ | ----------- | --------------------------------------------------------- | | werbeo | API | Flora-MV (through WerBeo API) |

Developing a local database plugin

You can derive a JSON database for your plugin from a CSV table by using Floralink Generator. Look at the plugins in this library for examples.

Source databases to use with Floralink need to have a taxonomic reference. Floralink uses GermanSL (v1.5.1) and doesn't support other taxonomic reference databases (yet).

File structure

Basic file structure of a local database plugin:

/source
  |__database.csv
  |__LICENSE
database.json
index.js
mappings.js
README.md

index.js

Example index.js (Ellenberg plugin):

import database from "database.json";

export default {
  pluginType: "taxonspecific",
  sourceType: "local",
  id: "ellenberg",
  version: "1991-1",
  taxonReferencePlugin: {
    name: "germansl",
    version: "1.5.1",
  },
  title: "Ökologische Zeigerwerte",
  description:
    "Das ökologische Verhalten gegenüber einem bestimmten Standortfaktor [...]",
  sources: {
    primary: {
      citation:
        "Ellenberg, H. (1991): Zeigerwerte der Gefäßpflanzen (ohne Rubus). [...]",
      citationShort: "Ellenberg 1991",
    },
    // ...
  },
  database,
};