Difference between revisions of "Best Practices"

From Linked Earth Wiki
Jump to: navigation, search
m (Move figure)
(Introductions)
Line 1: Line 1:
By design, the LinkedEarth wiki is a collaborative platform to edit paleoclimate datasets and contribute knowledge about the field. As such, anyone within the LinkedEarth community can edit datasets and most of the pages on this wiki (with the exception of pages with a copyright sign, see [[LinkedEarth_Ontology | this page]] for an explanation.).
+
By design, the LinkedEarth wiki is a collaborative platform to edit paleoclimate datasets and contribute knowledge about the field. As such, anyone within the LinkedEarth community can edit datasets and most of the pages on this wiki (with the exception of pages with a copyright sign, see [[LinkedEarth_Ontology | this page]] for an explanation.). This page is meant as a best practice guide for creating new pages and modifying existing ones. Specifically, we propose guidelines for:
 +
*Editing existing datasets by third-party contributors
 +
*Naming pages with a unique identifier
 +
*Version the datasets following changes to model outputs (e.g., inferring new temperatures from existing raw measurements) and changes to the raw measurements.
  
 
We expect this guide to be updated often as new datasets are added and needs arise, so please check for updates regularly.
 
We expect this guide to be updated often as new datasets are added and needs arise, so please check for updates regularly.
 
'''Note'''
 
 
Wiki entries (other than text and numbers) essentially create a new page on the wiki. Therefore, it is important to give unique identifiers to these pages. This guide is meant to help in choosing appropriate name for describing the dataset.
 
  
 
== Datasets ==
 
== Datasets ==

Revision as of 11:57, 11 April 2017

By design, the LinkedEarth wiki is a collaborative platform to edit paleoclimate datasets and contribute knowledge about the field. As such, anyone within the LinkedEarth community can edit datasets and most of the pages on this wiki (with the exception of pages with a copyright sign, see this page for an explanation.). This page is meant as a best practice guide for creating new pages and modifying existing ones. Specifically, we propose guidelines for:

  • Editing existing datasets by third-party contributors
  • Naming pages with a unique identifier
  • Version the datasets following changes to model outputs (e.g., inferring new temperatures from existing raw measurements) and changes to the raw measurements.

We expect this guide to be updated often as new datasets are added and needs arise, so please check for updates regularly.

Datasets

  • What constitutes a dataset?
  • What constitutes a data table?
  • Updating datasets following a compilation

New Datasets

Existing Datasets

Original contributors

Third Party contributors

Versioning system

Nomenclature

Dataset Name

The naming convention for datasets is SiteName.FirstAuthor.PubYear. For instance, for this dataset, the SiteName is MD98-2181 (the name of the marine sediment core), the first author is Khider and the dataset was first published in 2014: MD982181.Khider.2014 as show on Figure 1.

DatasetName at the top of a Dataset Page on the LinkedEarth wiki.

If uploading from a LiPD file, the dataset name should be automatically filled out for you.

Following this convention from the start is important since many of the pages are named after the DatasetName.

Publication

Publications are identified on the wiki using their DOI. For instance, the Anand et al. (2003) publication corresponds to the page Publication.10.1029/2002PA000846.