Skip to content

Commit

Permalink
add custom css for boxes & toc
Browse files Browse the repository at this point in the history
* css for making TOC section headers more visible
* css for callout boxes to highlight important notes or warnings
* added a download link to download the term checklist
  • Loading branch information
EliLawrence committed Sep 4, 2024
1 parent 3adb9e0 commit 8b0aa5d
Show file tree
Hide file tree
Showing 9 changed files with 257 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- uses: r-lib/actions/setup-r@v2
- uses: r-lib/actions/setup-pandoc@v2
- name: Install rmarkdown
run: Rscript -e 'install.packages(c("rmarkdown", "bookdown"))'
run: Rscript -e 'install.packages(c("rmarkdown", "bookdown","fontawesome"))'
- name: Render Book
run: Rscript build.R
- name: Create cname file
Expand Down
2 changes: 2 additions & 0 deletions checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Note that when you publish your dataset on the IPT, if you use a term not listed
- x/- term is recommended only for the Occurrence core
- -/x term is recommended only for the Occurrence extension

<a href="/docs/OBIS-termchecklist.csv" download>**Click here to download the checklist.**</a>

| Term | OBIS Required | Term's DarwinCore Class | Event Table | Occurrence Table (Core/Extension) | eMoF Table | DNA Table |
|---------|-----------|---------|----------|--------|----------|----------|
| eventDate | required | event | x | x/- | | |
Expand Down
10 changes: 8 additions & 2 deletions dna_data.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
## DNA derived data

<div class="callbox-blue">

*Note: OBIS guidelines have not yet been updated to reflect changes that allow DNA Derived data to be linked to Event core tables. We will update this page soon.*

</div>

**Contents:**

- [Introduction](#introduction-to-dna-data)
- [How to find genetic data in OBIS](#how-to-find-genetic-data-in-obis)
- [Guidelines for compiling eDNA and metabarcoding data](#compiling-edna-and-metabarcoding-datasets)
- [eDNA & DNA Derived use cases](#edna-and-dna-derived-data-example)
- [16S rRNA metabarcoding example](#16s-rrna-gene-metabarcoding-data-of-pico--to-mesoplankton)
- [16S rRNA metabarcoding example](#16s-rrna-gene-metabarcoding-data-of-pico-to-mesoplankton)
- [Unknown sequences](#unknown-sequences)
- [Guidelines for compiling qPCR data](#compiling-qpcr-datasets)

Expand Down Expand Up @@ -206,7 +212,7 @@ For a detailed description of the steps taken to process the data, including alg
| GTACACACCGCCCGTC | TGATCCTTCTGCAGGTTCACCTAC | 1391f | EukBr | Amaral-Zettler et al. 2009 |
| GTACACACCGCCCGTC | TGATCCTTCTGCAGGTTCACCTAC | 1391f | EukBr | Amaral-Zettler et al. 2009 |

##### 16S rRNA gene metabarcoding data of Pico- to Mesoplankton
##### 16S rRNA gene metabarcoding data of Pico to Mesoplankton

DNA derived datasets can also include an extendedMeasurementsOrFact (eMoF) extension file, in addition to the Occurrence and DNA derived extensions. In this example, environmental measurements were provided in an eMoF file, in addition to the DNA derived data and occurrence data. Here we show how to incorporate such measurements in the extensions.

Expand Down
203 changes: 203 additions & 0 deletions docs/OBIS-termchecklist.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
Term , OBIS Required , Term's DarwinCore Class , Event Table , Occurrence Table (Core/Extension) , eMoF Table , DNA Table �
eventDate,required,event,x,x/-,�,�
eventID,required,event,x,-/x,x,�
decimalLatitude,required,location,x,x/-,�,�
decimalLongitude,required,location,x,x/-,�,�
occurrenceID,required,occurrence,�,x/x,x,x
occurrenceStatus,required,occurrence,�,x/x,�,�
basisOfRecord,required,record,�,x/x,�,�
scientificName,required,taxon,�,x/x,�,�
scientificNameID,strongly recommended,taxon,�,x/x,�,�
DNA_sequence,strongly recommended,dna,�,�,�,x
env_broad_scale,strongly recommended,dna,�,�,�,x
env_local scale,recommended,dna,�,�,�,x
env_medium,strongly recommended,dna,�,�,�,x
lib_layout,recommended,dna,�,�,�,x
nucl_acid_amp,recommended,dna,�,�,�,x
nucl_acid_ext,recommended,dna,�,�,�,x
otu_class_appr,recommended,dna,�,�,�,x
otu_db,recommended,dna,�,�,�,x
otu_seq_comp_appr,recommended,dna,�,�,�,x
pcr_primer_forward,strongly recommended,dna,�,�,�,x
pcr_primer_name_forward,strongly recommended,dna,�,�,�,x
pcr_primer_name_reverse,strongly recommended,dna,�,�,�,x
pcr_primer_reference,strongly recommended,dna,�,�,�,x
pcr_primer_reverse,strongly recommended,dna,�,�,�,x
samp_name,recommended,dna,�,�,�,x
samp_vol_we_dna_ext,recommended,dna,�,�,�,x
seq_meth,recommended,dna,�,�,�,x
sop,recommended,dna,�,�,�,x
target_gene,strongly recommended,dna,�,�,�,x
target_subfragment,strongly recommended,dna,�,�,�,x
day,recommended,event,x,x/-,�,�
endDayOfYear,recommended,event,x,x/-,�,�
eventType,strongly recommended,event,x,�,�,�
eventRemarks,optional,event,x,x/-,�,�
eventTime,recommended,event,x,x/-,�,�
fieldNotes,optional,event,x,�,�,�
fieldNumber,optional,event,x,�,�,�
habitat,recommended,event,x,�,x,�
month,strongly recommended,event,x,x/-,�,�
parentEventID,required (if exists),event,x,-/x,�,�
sampleSizeUnit,strongly recommended,event,x^,x^/-,x,�
sampleSizeValue,strongly recommended,event,x^,x^/-,x,�
samplingEffort,strongly recommended,event,x^,x^/-,x,�
samplingProtocol,strongly recommended,event,x^,x^/-,x,�
startDayOfYear,recommended,event,x,�,�,�
verbatimEventDate,recommended,event,x,�,�,�
year,strongly recommended,event,x,x/-,�,�
bed,optional,geologicalContext,x,x/x,�,�
earliestAgeOrLowestStage,optional,geologicalContext,x,x/x,�,�
earliestEonOrLowestEonothem,optional,geologicalContext,x,x/x,�,�
earliestEpochOrLowestSeries,optional,geologicalContext,x,x/x,�,�
earliestEraOrLowestErathem,optional,geologicalContext,x,x/x,�,�
earliestPeriodOrLowestSystem,optional,geologicalContext,x,x/x,�,�
formation,optional,geologicalContext,x,x/x,�,�
group,optional,geologicalContext,x,x/x,�,�
highestBiostratigraphicZone,optional,geologicalContext,x,x/x,�,�
latestAgeOrHighestStage,optional,geologicalContext,x,x/x,�,�
latestEonOrHighestEonothem,optional,geologicalContext,x,x/x,�,�
latestEpochOrHighestSeries,optional,geologicalContext,x,x/x,�,�
latestEraOrHighestErathem,optional,geologicalContext,x,x/x,�,�
latestPeriodOrHighestSystem,optional,geologicalContext,x,x/x,�,�
lithostratigraphicTerms,optional,geologicalContext,x,x/x,�,�
lowestBiostratigraphicZone,optional,geologicalContext,x,x/x,�,�
member,optional,geologicalContext,x,x/x,�,�
dateIdentified,optional,identification,�,x/x,�,�
identificationID,optional,identification,�,x/x,�,�
identificationQualifier,recommended,identification,�,x/x,�,�
identificationReferences,optional (required for imaging data),identification,�,x/x,�,�
identificationRemarks,recommended,identification,�,x/x,�,�
identificationVerificationStatus,optional (required for imaging data),identification,�,x/x,�,�
identifiedBy,optional (required for imaging data),identification,�,x/x,�,�
identifiedByID,optional,identification,�,x/x,�,�
typeStatus,optional,identification,�,x/x,�,�
continent,strongly recommended,location,x,x/-,�,�
coordinatePrecision,strongly recommended,location,x,x/-,�,�
coordinateUncertaintyInMeters,strongly recommended,location,x,x/-,�,�
country,recommended,location,x,x/-,�,�
countryCode,optional,location,x,x/-,�,�
county,optional,location,x,x/-,�,�
footprintSpatialFit,optional,location,x,x/-,�,�
footprintSRS,optional,location,x,x/-,�,�
footprintWKT,recommended,location,x,x/-,�,�
geodeticDatum,recommended,location,x,x/-,�,�
georeferencedBy,optional,location,x,x/-,�,�
georeferencedDate,optional,location,x,x/-,�,�
georeferenceProtocol,optional,location,x,x/-,�,�
georeferenceSources,optional,location,x,x/-,�,�
higherGeography,optional,location,x,x/-,�,�
higherGeographyID,optional,location,x,x/-,�,�
island,optional,location,x,x/-,�,�
islandGroup,optional,location,x,x/-,�,�
locality,recommended,location,x,x/-,�,�
locationAccordingTo,recommended,location,x,x/-,�,�
locationID,strongly recommended,location,x,x/-,�,�
locationRemarks,recommended,location,x,x/-,�,�
maximumDepthInMeters,strongly recommended,location,x,x/-,�,�
maximumDistanceAboveSurfaceInMeters,optional,location,x,x/-,�,�
maximumElevationInMeters,optional,location,x,x/-,�,�
minimumDepthInMeters,strongly recommended,location,x,x/-,�,�
minimumDistanceAboveSurfaceInMeters,optional,location,x,x/-,�,�
minimumElevationInMeters,optional,location,x,x/-,�,�
municipality,optional,location,x,x/-,�,�
pointRadiusSpatialFit,optional,location,x,x/-,�,�
stateProvince,optional,location,x,x/-,�,�
verbatimCoordinates,optional,location,x,x/-,�,�
verbatimCoordinateSystem,optional,location,x,x/-,�,�
verbatimDepth,optional,location,x,x/-,�,�
verbatimElevation,optional,location,x,x/-,�,�
verbatimLatitude,optional,location,x,x/-,�,�
verbatimLocality,optional,location,x,x/-,�,�
verbatimLongitude,optional,location,x,x/-,�,�
verbatimSRS,optional,location,x,x/-,�,�
waterBody,recommended,location,x,x/-,�,�
materialSampleID,recommended,materialSample,�,x/x,�,�
measurementAccuracy,recommended,measurementOrFact,�,�,x,�
measurementDeterminedBy,optional,measurementOrFact,�,�,x,�
measurementDeterminedDate,optional,measurementOrFact,�,�,x,�
measurementID,recommended,measurementOrFact,�,�,x,�
measurementMethod,recommended,measurementOrFact,�,�,x,�
measurementRemarks,recommended,measurementOrFact,�,�,x,�
measurementType,strongly recommended,measurementOrFact,�,�,x,�
measurementTypeID,strongly recommended,measurementOrFact,�,�,x,�
measurementUnit,strongly recommended,measurementOrFact,�,�,x,�
measurementUnitID,strongly recommended,measurementOrFact,�,�,x,�
measurementValue,strongly recommended,measurementOrFact,�,�,x,�
measurementValueID,strongly recommended,measurementOrFact,�,�,x,�
associatedMedia,recommended,occurrence,�,x/x,�,�
associatedReferences,optional,occurrence,�,x/x,�,�
associatedSequences,recommended,occurrence,�,x/x,�,�
associatedTaxa,optional,occurrence,�,x/x,�,�
behavior,optional,occurrence,�,x^/x^,x,�
catalogNumber,recommended,occurrence,�,x/x,�,�
disposition,optional,occurrence,�,x/x,�,�
establishmentMeans,optional,occurrence,�,x/x,�,�
georeferenceVerificationStatus,recommended,occurrence,x,x/-,�,�
organismQuantity (preferred over individualCount),strongly recommended,occurrence,�,x^/x^,x,�
organismQuantityType (preferred over individualCount),strongly recommended,occurrence,�,x^/x^,x,�
individualCount,recommended,occurrence,�,x^/x^,x,�
lifeStage,optional,occurrence,�,x^/x^,x,�
occurrenceRemarks,recommended,occurrence,�,x/x,�,�
otherCatalogNumbers,optional,occurrence,�,x/x,�,�
preparations,optional,occurrence,�,x/x,�,�
recordedBy,recommended,occurrence,�,x/x,�,�
recordedByID,recommended,occurrence,�,x/x,�,�
recordNumber,recommended,occurrence,�,x/x,�,�
reproductiveCondition,optional,occurrence,�,x^/x^,x,�
sex,optional,occurrence,�,x^/x^,x,�
associatedOccurrences,optional,organsim,�,x/x,�,�
associatedOrganisms,optional,organsim,�,x/x,�,�
organismID,recommended,organsim,�,x/x,�,�
organismName,optional,organsim,�,x/x,�,�
organismRemarks,optional,organsim,�,x/x,�,�
organismScope,optional,organsim,�,x/x,�,�
previousIdentifications,recommended,organsim,�,x/x,�,�
accessRights,recommended,record,x,x/-,�,�
bibliographicCitation,recommended,record,x,x/-,�,�
collectionCode,optional,record,x,x/x,�,�
collectionID,optional,record,x,x/x,�,�
dataGeneralizations,optional,record,x,x/x,�,�
datasetID,recommended,record,x,x/x,�,�
datasetName,recommended,record,x,x/x,�,�
dynamicProperties,recommended,record,x,x/x,�,�
informationWithheld,optional,record,x,x/x,�,�
institutionCode,optional,record,x,x/x,�,�
institutionID,optional,record,x,x/x,�,�
language,recommended,record,x,x/x,�,�
license,strongly recommended,record,x,x/x,�,�
modified,recommended,record,x,x/x,�,�
ownerInstitutionCode,optional,record,x,x/x,�,�
references,recommended,record,x,x/x,�,�
rightsHolder,recommended,record,x,x/x,�,�
type,strongly recommended,record,x,x/x,x,�
acceptedNameUsage,recommended,taxon,�,x/x,�,�
acceptedNameUsageID,recommended,taxon,�,x/x,�,�
higherClassification,recommended,taxon,�,x/x,�,�
infraspecificEpithet,recommended,taxon,�,x/x,�,�
nameAccordingToID,recommended,taxon,�,x/x,�,�
namePublishedInID,optional,taxon,�,x/x,�,�
namePublishedInYear,optional,taxon,�,x/x,�,�
nomenclaturalCode,optional,taxon,�,x/x,�,�
nomenclaturalStatus,optional,taxon,�,x/x,�,�
verbatimIdentification,recommended,identification,,x/x,,
originalNameUsage,recommended,taxon,�,x/x,�,�
originalNameUsageID,recommended,taxon,�,x/x,�,�
parentNameUsage,recommended,taxon,�,x/x,�,�
parentNameUsageID,recommended,taxon,�,x/x,�,�
phylum,recommended,taxon,�,x/x,�,�
scientificNameAuthorship,recommended,taxon,�,x/x,�,�
specificEpithet,recommended,taxon,�,x/x,�,�
subgenus,recommended,taxon,�,x/x,�,�
taxonConceptID,optional,taxon,�,x/x,�,�
taxonID,optional,taxon,�,x/x,�,�
taxonomicStatus,optional,taxon,�,x/x,�,�
taxonRank,strongly recommended,taxon,�,x/x,�,�
taxonRemarks,recommended,taxon,�,x/x,�,�
verbatimTaxonRank,recommended,taxon,�,x/x,�,�
vernacularName,recommended,taxon,�,x/x,�,�
class,recommended,taxon,�,x/x,�,�
family,recommended,taxon,�,x/x,�,�
genus,strongly recommended,taxon,�,x/x,�,�
kingdom,strongly recommended,taxon,�,x/x,�,�
order,strongly recommended,taxon,�,x/x,�,�
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ This manual provides a comprehensive walk-through on how to contribute data to O

The manual is designed to provide guidelines for OBIS nodes and data providers, ensuring that data published via OBIS are of high quality and adhere to internationally recognized standards. It also serves as a resource for data users on how to access, process, and visualize data from OBIS. See the [quick links](linklist.html) page for a quick reference to various guides, tools, and resources.

<div class="callbox-blue">

`r fontawesome::fa(name="youtube", fill="red")` See the [OBIS YouTube](https://www.youtube.com/playlist?list=PLlgUwSvpCFS4TS7ZN0fhByj_3EBZ5lXbF) playlist for many helpful How-to videos!

</div>

The OBIS manual is a dynamic document and is revised on a regular basis. We welcome suggestions for additions and changes, which can be sent to [[email protected]](mailto:[email protected]), the OBIS Capacity Development Task Team at [[email protected]](mailto:[email protected]), and/or submitted as issues at <https://github.com/iobis/manual/issues>.

## Guidelines on the sharing and use of data in OBIS
Expand Down
4 changes: 2 additions & 2 deletions linklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Below you will find a convenient list of important or relevant websites and reso
* [Darwin Core term Quick Reference Guide](https://dwc.tdwg.org/terms/)
* [Darwin Core text guide](https://dwc.tdwg.org/text/)
* [Publishing DNA-derived data guide](https://docs.gbif.org/publishing-dna-derived-data/en/)
* [OBIS Data formatting tutorial YouTube series](https://www.youtube.com/playlist?list=PLlgUwSvpCFS4TS7ZN0fhByj_3EBZ5lXbF): this series covers topics including creating identifiers (eventID, occurrenceID), creating data tables (event, Occurrence, eMoF), accessing OBIS data, taxon matching, running QC checks, etc.
* `r fontawesome::fa(name="youtube", fill="red")` [OBIS Data formatting tutorial YouTube series](https://www.youtube.com/playlist?list=PLlgUwSvpCFS4TS7ZN0fhByj_3EBZ5lXbF): this series covers topics including creating identifiers (eventID, occurrenceID), creating data tables (event, Occurrence, eMoF), accessing OBIS data, taxon matching, running QC checks, etc.
* De Pooter et al. 2017. Toward a new data standard for combined marine biological and environmental datasets - expanding OBIS beyond species occurrences. Biodiversity Data Journal 5: e10989. hdl.handle.net/10.3897/BDJ.5.e10989
* Duncan et al. (2021). A standard approach to structuring classified habitat data using the Darwin Core Extended Measurement or Fact Extension. EMODnet report. <https://www.emodnet-seabedhabitats.eu/resources/documents-and-outreach/#h3298bcd0a15741a8a0ac1c8b4576f7c5> (note you must refine search to Technical Reports from 2021 to identify this report as it does not have an individual link)

Expand All @@ -31,7 +31,7 @@ Below you will find a convenient list of important or relevant websites and reso

#### Controlled vocabulary

* [OBIS YouTube Vocabulary series](https://www.youtube.com/playlist?list=PLlgUwSvpCFS4hADB7Slf44V1KJauEU6Ul): this series demonstrates how to use the [vocabulary decision tree](vocabulary#selecting-p01-codes-for-measurementtypeid) in conjunction with the SeaDataNet P01 facet search in order to find/select vocabularies for eMoF measurements
* `r fontawesome::fa(name="youtube", fill="red")` [OBIS YouTube Vocabulary series](https://www.youtube.com/playlist?list=PLlgUwSvpCFS4hADB7Slf44V1KJauEU6Ul): this series demonstrates how to use the [vocabulary decision tree](vocabulary#selecting-p01-codes-for-measurementtypeid) in conjunction with the SeaDataNet P01 facet search in order to find/select vocabularies for eMoF measurements
* [SeaDataNet P01 facet search](https://vocab.seadatanet.org/p01-facet-search): recommended interface to search for P01 codes used to populate measurementTypeID field. Note that the free text search is best used by supplying one search term at a time (it does not search the same way we use Google)
* [OBIS GitHub repository for vocabulary](https://github.com/nvs-vocabs/OBISVocabs/issues): use this repository to request new terms for measurements related to OBIS data
* [Darwin Core Basis of Record Vocabulary](https://rs.gbif.org/vocabulary/dwc/basis_of_record_2022-02-02.xml): definitions for terms used to populate basisOfRecord
Expand Down
29 changes: 29 additions & 0 deletions style.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,33 @@ table {
}
.book .book-body .page-wrapper .page-inner {
max-width: 80% !important;
}
.book .book-summary ul.summary li span {
opacity: 1 !important;
color: #1e74ac;
font-size: 16px !important;
}
.callbox-blue {
background: lightcyan;
border-style: none none none solid;
border-width: 5px;
border-color: #0c3f61;
padding-left: 10px;
margin-left: 10px;
font-weight: bold;
}
.callbox-caution {
background: lightyellow;
border-style: none none none solid;
border-width: 5px;
border-color: #efaf36;
padding-left: 70px;
box-shadow: 5px 5px #777960;
}
.caution{
background-image: url("images/icons/triangle-exclamation-solid-yellow.png");
background-size: 50px 50px;
background-position-y: 45px;
background-position-x: 5px;
background-repeat: no-repeat;
}
7 changes: 6 additions & 1 deletion vocabulary.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,12 @@ The obistools R package also has the [map_fields function](https://github.com/io

The MeasurementOrFact terms `measurementType`, `measurementValue`, and `measurementUnit` are completely unconstrained and can be populated with free text. While free text offers the advantage of capturing complex and as yet unclassified information, there is inevitable semantic heterogeneity (e.g., of spelling, wording, or language) that becomes a challenge for effective data interoperability and analysis. For example, if you were interested in finding all records related to length measurements, you would have to try to account for all the different ways “length” was recorded by data providers (length, Length, len, fork length, etc.).

> You can use the [OBIS Measurement Type search tool](https://mof.obis.org/) to see the diversity of `measurementTypes` that exist across published datasets in OBIS. However note that **any `measurementTypeIDs` listed in this tool are _solely_ for consultation purposes**. In some cases codes may have been incorrectly chosen for the associated `measurementType`. You should always choose `measurementTypeIDs` based on your own data and the guidelines in this manual.
<div class="callbox-caution caution">

**Caution:**
You can use the [OBIS Measurement Type search tool](https://mof.obis.org/) to see the diversity of `measurementTypes` that exist across published datasets in OBIS. However note that **any `measurementTypeIDs` listed in this tool are _solely_ for consultation purposes**. In some cases codes may have been incorrectly chosen for the associated `measurementType`. You should always choose `measurementTypeIDs` based on your own data and the guidelines in this manual.

</div>

The 3 identifier terms `measurementTypeID`, `measurementValueID` and `measurementUnitID` are used to standardize the measurement types, values and units.

Expand Down

0 comments on commit 8b0aa5d

Please sign in to comment.