Difference between revisions of "Best Practices"

Revision as of 20:45, 18 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

The following section aims to provide guidelines on creating new dataset or editing existing wiki pages, including datasets used in compilations.

New Datasets

We strongly recommend first creating a LiPD file rather than entering all the data and metadata from scratch on the wiki. As of April 2017, the most expeditious way to convert your data into the LiPD format is to use our Excel Template (File:LiPDv1.2 template.xlsx) and the Python LiPD Utilities. This guide will assist you in entering the necessary data and metadata information.

If you decide to enter a dataset manually (yes, it is a possible although extremely painful process):

1. Upload your data in csv format using the 'Upload File' link in the sidebar. Make sure you name them appropriately by referring to the nomenclature section on this page. The wiki will suggest names for you to use.
2. Create a new page using the name SiteName.DatasetYear.ContributorName and set the Category of the new page to Category:Dataset (L). Note: To be able to create a page, you need to enter some text in the WikiText box. You'll be able to delete it the page create by clicking on edit at the top of the page.
3. The wiki will automatically suggest standard properties. Answer as many as possible. Note: If the answer to a Property results in the creation of a new class (i.e., the box doesn't specify text or number), then you'll be essentially creating a new wiki page. Follow our nomenclature. If you make a typo, just fixing the typo in the link will not automatically redirect the page. The best approach is to rename the landing page.

Existing Datasets

For existing datasets, we recommend updating the data and metadata directly on the wiki rather than uploading a new LiPD file. Please follow the guidelines below for original contributors and third party contributors.

One major exception to this rule is an update that requires adding a new variable (i.e., adding a column to a csv file) to an existing data table for the original contributor of the dataset.

• To update data:

It may be require to update a new csv file to fix a minor typo in the data.

Versioning system

Original contributors

You can update your dataset at any times on the wiki. Just follow the versioning and nomenclature rules.

Third Party contributors

Anyone with basic editor privilege can edit wiki pages.

Compilation

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.