Skip to content

Commit

Permalink
fixing internal links and fig sizes
Browse files Browse the repository at this point in the history
* fixed link formatting on various pages
* increased size of images on most pages
  • Loading branch information
EliLawrence committed May 5, 2023
1 parent c9a7d01 commit b7cd917
Show file tree
Hide file tree
Showing 24 changed files with 147 additions and 137 deletions.
14 changes: 7 additions & 7 deletions access.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ We have produced a video demonstration of how to use the Mapper.

The mapper allows users to visualize and inspect subsets of OBIS data. A variety of filters are available (taxonomic, geographic, time, data quality) and multiple layers can be combined in a single view. Layers can be downloaded as CSV files.

![Screenshot demonstrating where how to download a particular layer](images/mapper-DL.png){width=40%}
![*Screenshot demonstrating where how to download a particular layer*](images/mapper-DL.png){width=60%}

When you download data from the mapper, you will be given the option to include eMoF and/or DNA Derived Data extensions alongside the Event and Occurrence data. You must check the boxes of extensions you want to include in your download.

![Screenshot showing the popup confirmation for which extensions you want to include in your download from the OBIS Mapper](images/mapper-extensions.png){width=40%}
![*Screenshot showing the popup confirmation for which extensions you want to include in your download from the OBIS Mapper*](images/mapper-extensions.png){width=70%}

After downloading, you will notice that the Event and Occurrence data is flattened into one table, called “Occurrence.csv”. Upon inspecting this file in your viewer of choice, you will see it contains all 225 possible DwC fields, although not every field will contain data for each observation. Any extensions you checked will be downloaded as separate tables.

Expand Down Expand Up @@ -83,15 +83,15 @@ From the OBIS homepage, you can search for data in the search bar in the middle

When you search by dataset you will notice an additional option appears for [advanced search options](https://obis.org/datasets). This will allow you to identify specific datasets, and apply filters for OBIS nodes and whether datasets include extensions.

![OBIS homepage search, showing where to find the advanced search link](images/obis-homepagesearch.png){width=50%}
![*OBIS homepage search, showing where to find the advanced search link*](images/obis-homepagesearch.png){width=70%}

Regardless if you found a dataset through the homepage or the advanced Dataset search, you will be able to navigate to individual dataset pages. For individual dataset pages (instead of aggregate pages for e.g., a Family) there are three buttons available:

* Report issue - allows you to report any issues with the dataset in question
* Source DwC-A - download the dataset as a Darwin Core-Archive file. This will provide all data tables as separate files within a zipped folder
* To mapper - this will open another browser with the data shown in the Mapper

![Dataset download](images/dataset-DL.png){width=50%}
![*Dataset download*](images/dataset-DL.png){width=70%}

If you searched for aggregate datasets (e.g., all Crustacea records, all records from OBIS-Canada, etc.), the `source DwC-A` button will not be available to you. To download these data subsets, you must click `to mapper` and then [download the data from the Mapper as a CSV](#mapper).

Expand All @@ -101,11 +101,11 @@ If you searched for aggregate datasets (e.g., all Crustacea records, all records

To obtain a full export of OBIS data, navigate to the OBIS homepage, click on Data from the top navigation bar, then select [Data Access](https://obis.org/data/access/) from the dropdown menu.

![OBIS homepage showing where to navigate to access full database exports](images/full-export1.png){width=50%}
![*OBIS homepage showing where to navigate to access full database exports*](images/full-export1.png){width=70%}

Here you will be able to download all occurrence records as a CSV or Parquet file. Note the disclaimer that such exports will not include measurement data, dropped records, or absence records. As with downloads from the Mapper, the exported file is a single Occurrence table. This table includes all provided Event and Occurrence data, as well as 68 fields added by the OBIS Quality Control Pipeline, including taxonomic information obtained from WoRMS.

![OBIS Data Access page](images/full-export2.png){width=50%}
![*OBIS Data Access page*](images/full-export2.png){width=70%}

## Finding your own data in OBIS

Expand All @@ -120,7 +120,7 @@ To find your own dataset in OBIS, you can use the same tools as finding any data

To contact the data provider, navigate to the page for the individual dataset in question (e.g., <https://obis.org/dataset/80479e14-2730-436d-acaa-b63bdc7dd06f>). Under the “Contacts” section, there will be a list of individuals you can contact. Clicking any name will direct you to your system’s default email program. For example:

![Example of contact section on a dataset homepage access via the OBIS search](images/contact-dataprovider.png){width=40%}
![*Example of contact section on a dataset homepage access via the OBIS search*](images/contact-dataprovider.png){width=70%}

If you are the node manager and need to contact the data provider about a particular dataset, contact information should be provided in the metadata and you can contact them from information provided.

Expand Down
2 changes: 1 addition & 1 deletion checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

There are many Darwin Core terms listed in the [TDWG quick reference guide](https://dwc.tdwg.org/terms/). However, not all these terms are necessary for publishing data to OBIS.

For your convenience, we have created a checklist of all the Darwin Core terms relevant for OBIS data providers. You can reference this list to quickly see which terms are required by OBIS, which file (Event, Occurrence, eMoF, DNA) they can be found in, and which Darwin Core class it relates to. These terms correlate with the [IPT vocabulary mapping](ipt#map-your-data-to-darwin-core.html) you will do when it comes time to publish your dataset. You may notice some terms are accepted in multiple data tables (e.g., Event and Occurrence) - this is because it depends on your dataset structure. If you have an Event Core, you will include some terms that would not be included if you had Occurrence Core. For guidance on specific class terms (e.g., location, taxonomy, etc.), see the [Darwin Core](darwin_core#darwin-core-guidelines.html) section of the manual.
For your convenience, we have created a checklist of all the Darwin Core terms relevant for OBIS data providers. You can reference this list to quickly see which terms are required by OBIS, which file (Event, Occurrence, eMoF, DNA) they can be found in, and which Darwin Core class it relates to. These terms correlate with the [IPT vocabulary mapping](ipt.html#map-your-data-to-darwin-core) you will do when it comes time to publish your dataset. You may notice some terms are accepted in multiple data tables (e.g., Event and Occurrence) - this is because it depends on your dataset structure. If you have an Event Core, you will include some terms that would not be included if you had Occurrence Core. For guidance on specific class terms (e.g., location, taxonomy, etc.), see the [Darwin Core](darwin_core.html#darwin-core-guidelines) section of the manual.

Note that when you publish your dataset on the IPT, if you use a term not listed below it will be an unmapped field and will **not** be published alongside your data. You may still wish to include such fields in your dataset if you are publishing to other repositories, just know that they will not be included in your OBIS dataset. You may include this information either by putting it in the `dynamicProperties` field in JSON format, or putting the information into the [eMoF](format_emof.html). Alternatively, you may have fields that you do not wish to be published and that do not correspond to one of these terms (e.g. personal notes). This is okay - if they are not mapped to one of the terms, that column in your dataset will not be published.

Expand Down
10 changes: 5 additions & 5 deletions common_formatissues.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ To resolve missing fields [marked as required](checklist.html) by OBIS, there ar

- **`eventDate`**

Ensure your eventDate is specified for each event, formatted according to [ISO 8601 standards](https://en.wikipedia.org/wiki/ISO_8601) (e.g., YYYY-MM-DD). We have developed [step by step guidelines](common_formatissues#temporal-dates-and-times.html) to help you format contemporary dates and durations into ISO formatting. If your date falls outside the range of acceptable dates - i.e., historical or geological data occurring before 1583 - please follow recommendations for [historical data](common_formatissues#historical-data.html).
Ensure your eventDate is specified for each event, formatted according to [ISO 8601 standards](https://en.wikipedia.org/wiki/ISO_8601) (e.g., YYYY-MM-DD). We have developed [step by step guidelines](common_formatissues.html#temporal-dates-and-times) to help you format contemporary dates and durations into ISO formatting. If your date falls outside the range of acceptable dates - i.e., historical or geological data occurring before 1583 - please follow recommendations for [historical data](common_formatissues.html#historical-data).

For any eventDate that is inferred from literature, you should document the original date in the `verbatimEventDate` field.

- **`decimalLongitude`** and **`decimalLatitude`**

First, if you have coordinate data, make sure they are [converted into decimal degrees](common_formatissues#converting-coordinates.html). If you do not have specific coordinate data then you must approximate the coordinates based on locality name. You can use the [Marine Regions gazetteer](https://www.marineregions.org/gazetteer.php?p=search) to search for your region of interest and obtain midpoint coordinates. Guidelines for using this tool and for dealing with uncertain geolocations can be found [here](common_formatissues#geographical-formats.html). You will have to make some comments in the `georeferenceRemarks` field if you are estimating coordinates.
First, if you have coordinate data, make sure they are [converted into decimal degrees](common_formatissues.html#converting-coordinates). If you do not have specific coordinate data then you must approximate the coordinates based on locality name. You can use the [Marine Regions gazetteer](https://www.marineregions.org/gazetteer.php?p=search) to search for your region of interest and obtain midpoint coordinates. Guidelines for using this tool and for dealing with uncertain geolocations can be found [here](common_formatissues.html#geographical-formats). You will have to make some comments in the `georeferenceRemarks` field if you are estimating coordinates.

- **`scientificName`**

This field should contain only the **originally documented** scientific name down to the lowest possible taxon rank, even if there are misspellings or if it is a current synonym. Class, or even Kingdom levels are accepted if more specific taxonomic levels are unknown. Comments about misspellings, etc. can be documented in the `taxonRemarks` field. Note that there may be special cases for eDNA and DNA derived data, see [specific guidelines](dna_data.html) for these cases.

You may encounter challenges filling this field if the species name is based on description or if its taxonomy was uncertain at time of sampling. For such uncertain taxonomy situations, see our guidelines [here](common_qc#uncertain-taxaonomic-information.html).
You may encounter challenges filling this field if the species name is based on description or if its taxonomy was uncertain at time of sampling. For such uncertain taxonomy situations, see our guidelines [here](common_qc.html#uncertain-taxaonomic-information).

- **`scientificNameID`**

Expand Down Expand Up @@ -61,7 +61,7 @@ For specifics on when to use each of these and which other fields should be popu

### Temporal: Dates and times

The date and time at which an event took place or an occurrence was recorded goes in `eventDate`. This field uses the [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601). OBIS recommends using the extended ISO 8601 format with hyphens. Note that all dates in OBIS become translated to UTC during the [quality control process implemented by OBIS](dataquality.html). Formatting your dates correctly ensures there will be no errors during this process.
The date and time at which an event took place or an occurrence was recorded goes in `eventDate`. This field uses the [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601). OBIS recommends using the extended ISO 8601 format with hyphens. Note that all dates in OBIS become translated to UTC during the [quality control process implemented by OBIS](https://github.com/iobis/obis-qc). Formatting your dates correctly ensures there will be no errors during this process.

ISO 8601 dates can represent moments in time at different resolutions, as well as time intervals, which use / as a separator. Date and times are separated by `T`. Timezones can be indicated at the end by using + or - the number of hours offset from UTC. If no timezone is indicated, then the time is assumed to be local time. When a date/time is recorded in UTC, a Z should be added at the end. Times must be written in the 24-hour clock system. If you do not know the time, you do not have to provide it. Please do not indicate unknown times as “00:00” as this indicates midnight.

Expand Down Expand Up @@ -171,7 +171,7 @@ All coordinates provided in the `decimalLatitude` or `decimalLongitude` fields i

![Screenshot of how to use the OBIS coordinate converter](images/coordinate_conversion.png){width=40%}

The [Map Tool tutorial](access#mapper.html) also reviews use of the coordinate conversion tool.
The [Map Tool tutorial](access.html#mapper) also reviews use of the coordinate conversion tool.

If your coordinates are in UTMs, then coordinate conversion can be a bit trickier. We suggest using the following [conversion tool](http://rcn.montana.edu/resources/Converter.aspx) to convert from UTM to decimal degrees. Note it is very important to ensure you have the correct UTM zone, otherwise the coordinate conversion will be incorrect. You can use this [ArcGIS map tool](https://www.arcgis.com/apps/View/index.html?appid=7fa64a25efd0420896c3336dc2238475) to visually confirm UTM zones.

Expand Down
Loading

0 comments on commit b7cd917

Please sign in to comment.