1.5 Frequently Asked Questions
Content
- General
- Darwin Core
- Formatting data
- Vocabulary
- Taxonomy
- Tools
- Quality Control
- Publishing
- Data Access
General
- I have data and want to publish to OBIS - what do I do?
- Why is it important to share and format data?
- How do I handle sensitive data?
- Where can I make suggestions for improvements on this Manual?
- Where can I find OBIS related training videos?
- What are the responsibilities of OBIS node managers?
- Where can I find marine datasets linked to the OBIS network by the GBIF registry, that now require endorising?
-
I am an OBIS node and need to update the contact information listed for my node on the OBIS website, how do I do that?
To update OBIS Node contact information listed at https://obis.org/contact/, you can edit the information here https://metadata.obis.org/ by signing in with your OceanExpert credentials.
Darwin Core
- Where can I learn about “Darwin Core”?
- I am having trouble understanding how Core and Extension tables relate to each other
- How does the OBIS format avoid redundancy in data
- How are extension tables (e.g. eMOF, occurrence) linked with the core table?
- What is the difference between Occurence Core and Event Core?
- What is the difference between eventID, occurrenceID, organismID, taxonID, scientificNameID, recordNumber, materialEntityID, materialSampleID, and catalogNumber?
-
What is the difference between
individualCount
, andorganismQuantity
, and which one should I use?The DwC term
individualCount
is used simply for documenting the number of individuals present at the time the occurrence happened. Conversely,organismQuantity
is used to record any type of quantity related to an organism or occurrence.organismQuantityType
may include the number of individuals, the % cover, biomass, the cover-abundance on the Braun-Blanquet Scale, etc. While both DwC terms can be placed in the Occurrence table, OBIS recommends also populating them in the eMoF table because of the standardization of terms and because you can link to sampling events and factual sampling information.
Formatting Data
- Is there a checklist of all required Darwin Core fields for OBIS?
- How does data flow in OBIS?
-
Can I add polygon data to OBIS?
Yes, polygons, lines, or combinations of polygon, line, and/or point data can be added to OBIS by using the
WKT strings can be generated using the OBIS Map Tool. The tool can also calculate a midpoint and a radius, which is added tofootprintWKT
field. This is can be used to record tracks, transects, tows, trawls, habitat extent, or when an exact location is not known. Midpoints of polygons can be added to the required fieldsdecimalLongitude
anddecimalLatitude
.decimalLongitude
,decimalLatitude
, andcoordinateUncertaintyInMeters
respectively. There is also anobistools
R function to calculate the centroid and radius for WKT polygons. - What should I do if I do not have the data for required fields by OBIS?
- How do I construct an eventID?
- How do I construct occurrenceID?
- What data goes into Occurrence core (or extension) and how do I set up this file?
- How do I set up an Event core table?
- How should I populate parent and child event information? Do I have to populate information for child events if the parent event already contains that information?
-
Do I have to provide decimalLatitude and decimalLongitude for the Event and Occurrence tables?
The answer may depend on your dataset structure, but generally, no. If you have Event core, then you do not need to repeat location information in the Occurrence table (but you can if you’d like). If you are using Occurrence core, then location information must be provided in the Occurrence table. - What data goes into extendedMeasurementOrFact (eMoF) and how do I set it up?
-
Can I have multiple eMoF tables, one for Event and one for Occurrence measurements?
Yes, you can create multiple eMoF tables if it is simpler for you to separate Event and Occurrence measurement data. However, you must ensure all tables include the correct identifiers, i.e. eventID for measurements related to events, and occurrenceID and eventID for measurements associated with occurrences. When you add multiple tables of the same type in the IPT, they will be treated as if they were a single table, so there is no issue if you would like to do this. - How do I format dates?
- How do I handle historical data?
- How do I convert coordinates to decimal degrees?
- How do I convert different geographical formats to WGS84?
- How do I compile acoustic, imaging, or other multimedia data for OBIS?
- How do I compile habitat data for OBIS?
- How do I compile tracking data for OBIS?
- How do I compile DNA and genetic data for OBIS?
-
What does sampleSize and organismQuantity refer to for genetic data?
For genetic data,
sampleSizeValue
andorganismQuantity
do not refer to the amount sampled nor the number of organisms. Instead these fields are related to either 1) the number of sequence reads for eDNA data or 2) the number of droplets/partitions for qPCR data. See DNA data guidelines for more details.
Vocabulary
- How do I map Measurement or Fact terms in OBIS with preferred BODC vocabulary?
- I can’t find a suitable vocabulary, what do I do? How do I request a new vocabulary term?
-
Should I use taxon-specific P01 codes to populate for measurementTypeID? e.g. http://vocab.nerc.ac.uk/collection/P01/current/A15985A1
No. You should never use taxon-specific P01 codes. This is because the taxa are already identified in the Occurrence table, in the fieldsscientificName
andscientificNameID
. - How should I match raw data fields with Darwin Core terminology?
Taxonomy
-
How do I document occurrences from unknown species, those new to science, or those with temporary names? e.g. Eurythenes sp. DISCOLL.PAP.JC165.674
Occurrences unknown or new to science should be documented according to recommendations by Horton et al. 2021. You should populate the
Please avoid simple alphanumeric codes (i.e. Eurythenes sp. 1, Eurythenes sp. A). Similar to creatingscientificName
field with the genus, and inidentificationQualifer
provide the ON sign ‘sp.’. However you must also indicate the reason why species-level identification is unavailable. To do this, supplement ‘sp.’ with either stet. (stetit) or indet. (indeterminabilis). If neither of these are applicable, (e.g. for undescribed new species), add a unique taxon identifier code after ‘sp.’ toidentificationQualifer
. For example Eurythenes sp. DISCOLL.PAP.JC165.674.eventIDs
oroccurrenceIDs
, you should strive to provide more complex and globally unique identifier. Identifiers could be constructed by combining higher taxonomic information with information related to a collection, institution, museum or collection code, sample number or museum accession number, expedition, dive number, or timestamp. This ensures namestrings will remain unique within a larger repositories like OBIS. It is also recommended to include these temporary names on specimen labels for physical specimens. -
Can scientificNameID be populated with an identifier (e.g. WoRMS LSID) representing an unaccepted taxon name?
Yes. The identifier in
scientificNameID
should always correspond with the name that is in thescientificName
field, even if the name is an unaccepted name in WoRMS. For example, the species name “Holothuria mammiculata” was provided, but this name is unaccepted in WoRMS. The accepted name is “Holothuria (Stauropora) pervicax Selenka, 1867”. In this casescientificNameID
should correspond to the original name with LSID urn:lsid:marinespecies.org:taxname:529968 because the ID must correlate with the name as recorded inscientificName
. -
What happens when a WoRMS taxonomy is changed? e.g. a species is reclassified
When species are reclassied in WoRMS, the original
scientificName
andscientificNameID
provided in a dataset remains unchanged. However WoRMS will list the old ID as “Unaccepted”, and link to the accepted taxon entry, and this will be reflected in the taxonomic information attached to a dataset download.For example, if we search for Manta birostris in OBIS (https://obis.org/taxon/105857), we see that the taxon’s status in WoRMS is unaccepted. At the bottom of the page it links to the currently accepted name: https://obis.org/taxon/1026118. We can find an occurrence which shows the source
scientificName
as “Manta” while the interpretedscientificName
is “Mobula”: https://obis.org/occurrence/00032775-252c-44b3-9c95-be1c9adb2fe4. We can also see thatoriginalScientificName
is populated with the source name in the intepreted output.As a user, you don’t have to trace species names. However if the datasets’s DwC-A is downloaded from the dataset page instead of obtained through R or the Mapper, all fields will contain the original value. It remains good practice to also check identifiers against WoRMS to see if any have been updated when you download data.
Tools
- How do I use the WoRMS taxon match tool?
- Can I fetch a full classification for a list of species from WoRMS?
- What do I do if my scientificName does not return a match from WoRMS?
- Where can I find DNA sequences published in OBIS?
-
Is there a template generator I can use to help create my Event, Occurrence, and eMoF tables?
Yes. There is an Excel template generator developed by Luke Marsden & Olaf Schneider as part of the Nansen Legacy project. Note this template generator is aimed at GBIF users, so make sure to account for and include required OBIS terms.
There is also this Excel to Darwin Core macro tool developed by GBIF Norway you can use to help generate templates.
- How do I georeference locations, including text-based descriptions?
Quality Control
- How do I do data quality control?
- What are the OBIS quality control flags?
- Why are certain records dropped in OBIS?
- What do I do when I am uncertain about the:
- What do I do with freshwater species that are part of my marine dataset?
Publishing
- How do I add my data to the OBIS database?
- What metadata do I have to provide? Where? How?
- How do you know which license to choose?
- How do I access the IPT?
- How do I use the IPT?
- Are there instructions for IPT administrators?
- How do I add DOI to my dataset?
- How do I publish to both GBIF and OBIS?
- How do I update my already published dataset?
Accessing data in OBIS
-
Can I get (or publish) other types of information from OBIS, besides occurences (e.g. bio-eco variables, DNA data, abiotic measurements, etc.)?
Yes! OBIS allows access to not only taxa occurrences, but also all kinds of measurement data including DNA data (see Contribute for a list of data accepted by OBIS). This data is recorded in the (Extended) Measurement Or Fact and DNA-Derived Data extension tables, respectively. To access this data when downloading, be sure to select MoF or DNA from the dropdown Dataset Type menu on the advanced dataset serach page. If you are obtaining data from the OBIS Mapper, make sure to check the box for MeasurementOrFact and/or DNADerivedData from the Extensions toggle section. When using the R package robis, use themof=TRUE
and/ordna=TRUE
arguments. More data filter options will be added in the future. - How do I download data from OBIS?
-
How do I load the full (.csv) export of OBIS data?
Loading the entire OBIS dataset uses a lot of memory and is probably not feasible on most desktop computers. You have a few potential options depending on the use case: i) process the data in smaller batches, or ii) load the dataset into a local database such as SQLite and use SQL queries to analyze the data
Otherwise, we recommend you use the parquet download which is available here, instead of the CSV. Then in R, you can use thearrow
package to work with parquet files. We also have a short tutorial on working with parquet files in R here, with an example application of this approach here (see first code block). - How can I use R to access OBIS data?
- How do I use the OBIS API to fetch and filter data?
- How do I contact the data provider?
- How can I cite OBIS datasets and downloads?
- What are the definitions of the field names in the downloads generated by OBIS?
-
How do I obtain a taxon checklist for an area?
There are a few possible ways to obtain a taxon checklist for a given area. We will obtain a checklist of species in the Albain EEZ as an example. To do this we will create a bounding box around our area of interest, and then apply filters to simplify the geometry.
library(mregions) library(dplyr) library(robis) library(sf) #obtain Albanian EEZ as sf geom <- mr_shp(key = "MarineRegions:eez", filter = "Albanian Exclusive Economic Zone", maxFeatures = NULL) #get WKT for the bounding box wkt <- st_as_text(st_as_sfc(st_bbox(geom)), digits = 6) #fetch occurrences for bounding box occ <- occurrence(geometry = wkt) %>% st_as_sf(coords = c("decimalLongitude", "decimalLatitude"), crs = 4326) #filter using geometry occ_filtered <- occ %>% filter(st_intersects(geometry, geom, sparse = FALSE)) %>% as_tibble() %>% select(-geometry) #get taxa alb_taxa <- occ_filtered %>% group_by(phylum, class, order, family, genus, species, scientificName) %>% summarize(records = n())
-
The dates look unusual in the download file. What are these, how do I convert them, and/or how do I obtain separate elements from them (e.g. month)?
The values in
date_start
,date_mid
, anddate_end
are unix timestamps which have been calculated from the ISO date in theeventDate
column. We can convert these numerical values to dates using the formula below.=(E2/86400000)+DATE(1970,1,1)
If, when you apply this formula, you still see numbers, you will need to set the cell formatting to Date. Once you have dates, you can obtain, e.g. months for seasonal analyses using:
=MONTH(H2)
You can also use this tool to convert timestamps.
-
How do I filter by or obtain trait information for OBIS data (e.g. all benthic organisms)?
Currently, it is not possible to filter OBIS data by trait. To do this, we recommend using the traits database of the World Register of Marine Species. For example, searching by “functional group”, you can specify benthos, plankton, nekton, etc.
-
How do I get data from multiple regions from OBIS?
If the areas OBIS currently uses does not work for your use case, then it is best to first define all the boundaries for the desired regions. OBIS can be queried using WKT polygons by providing a WKT string to the
geometry
parameter in therobis::occurrence
function. HOWEVER there are some limitations with respect to polygon complexity, and if it is too complex you will likely receive the error “The OBIS API was not able to process your request”.For more complex spatial queries we recommend indexing OBIS and GBIF data against polygons and using (finely) gridded versions of these datasets to make the process faster. We note we have not yet properly documented this process, but see the example script produced by Pieter Provoost below. The script first indexes a polygon to the H3 spatial index, then queries a gridded version of OBIS+GBIF data on AWS to get the species list, and finally fetches taxonomy from WoRMS for every species, which may take some time.
library(readr) library(h3jsr) library(sf) library(duckdb) library(DBI) library(dplyr) sf_use_s2(FALSE) # Read WKT from text file, convert to sf, and index to H3 resolution 7 # https://wktmap.com/?e6b28728 wkt <- read_file("wkt_21773.txt") geom <- st_as_sfc(wkt, crs = 4326) cells <- data.frame(cell = polygon_to_cells(geom, 7)[[1]]) # Set up duckdb connection and register cells table con <- dbConnect(duckdb()) dbSendQuery(con, "install httpfs; load httpfs;") duckdb_register(con, "cells", cells) # Join cells list and gridded species dataset species <- dbGetQuery(con, " select species, AphiaID from cells inner join read_parquet('s3://obis-products/speciesgrids/h3_7/*') h3 on cells.cell = h3.h3_07 group by species, AphiaID ") # Add WoRMS taxonomy id_batches <- split(species$AphiaID, ceiling(seq_along(species$AphiaID) / 50)) taxa_batches <- purrr::map(id_batches, worrms::wm_record) taxa <- bind_rows(taxa_batches) %>% select(AphiaID, scientificname, phylum, class, order, family, genus, scientificName = scientificname) # Get Mollusca species mollusca <- taxa %>% filter(phylum == "Mollusca")