Difference between revisions of "Best Practices"

Revision as of 20:43, 1 May 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 vs legacy datasets

New datasets are datasets that have recently been published and are often contributed by the original contributor of the study or someone closely associated with the creation of the datasets. This definition also includes older datasets that the PI may have placed on other public databases or have not come around to upload anywhere yet. In this instance, the contributors and the LinkedEarth member uploading the dataset may be the same.Therefore, most of the metadata fields can be filled by the person who was involved in the study since he/she might have the information readily available.

Legacy datasets are datasets that are publicly available (i.e., either on another database or published under U.S. funding) and are contributed by a LinkedEarth member not originally involved in the creation of the dataset. For datasets that are not publicly available (i.e., emailed directly to the LinkedEarth member by the original contributors), we recommend informing the contributors of your intent to upload their dataset on the LinkedEarth wiki.

The guidelines suggested below apply to both new and legacy datasets.

Versioning system

One of the properties of a dataset is the dataset version. In LinkedEarth, the dataset version follows the x.y.z notation where:

• x refers to changes in metadata and data following a publication. Examples of such changes include the creation of a new age model as part of a compilation or comparison or changes in the way a measured variable is calibrated to obtain an inferred variable (i.e. applying a different calibration model).
• y refers to changes to the data following a publication. Examples include adding data further back in time without changing the model underlying the interpretation.
• z refers to changes not associated with a publication and includes typos, addition of metadata either lifted from the publication or from the original contributor of the data (e.g., information from a laboratory notebook).

After the initial upload, set the dataset version to '0.0.0'.

Note: The dataset version is different from the compilation version. The versioning system of each compilation is left at the discretion of the group who created the compilation but should be explained on the compilation page.

Uploading a dataset for the first time on the wiki

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.

Once your dataset is in LiPD format, you can upload it on the wiki. This will automatically create most of the pages. Check that all the information is correct and once satisfied, update the dataset version to '0.0.0'.

If you decide to enter a dataset manually (not recommended):

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 this extra text from the page after you create it 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.

Changes to a dataset already on the wiki

For existing datasets, we recommend updating the data and metadata directly on the wiki rather than uploading a new LiPD file.

All changes to a dataset after the initial upload requires a change in the version of the file as outlined here. If you are planning to make a series of updates over the course of several days as part of the same work, only update the dataset version once you're trough with all the changes.

Changing existing data

Downloading a csv file from the wiki

Uploading a new version of a file on the wiki

Only the original contributor to the data and the person uploading the dataset can override the original csv file.

If the change requires creating another column or changing the underlying calibration, you should follow the instruction on adding data tables.

To update data:

1. go to this page and search for the name of the csv file you need to update.
2. Download the contributed csv file onto your computer by right-clicking on the name
3. Make the necessary corrections to the file and save it, using the same file name
4. To re-upload to the wiki, go back to file page from which you originally downloaded the file.
5. Click on Upload a new version of this file at the bottom of the page.

Changing existing metadata

The LinkedEarth wiki is mean as a collaborative platform for the curation of paleoclimate data. As such, anyone with basic editor privilege (i.e. a LinkedEarth member) can edit wiki pages.

If you're concerned about changes to your own dataset, please remember that you will receive a notification email when the pages are updated by another member of the community. If you do not agree with the changes being made to your dataset, we suggest that:

1. Contact the LinkedEarth member, who has made the change using the discussion page for the wiki page.
2. If you do not receive an answer within 7 business days, try contacting the user by email.
3. If you cannot resolve the issue within 30 business days, contact us.

Remember that these changes could be as simple as typos and maybe done automatically by the LinkedEarth team to bring your dataset up-to-date with the current ontology. See the Proxy Archive Ontology, the Proxy Observation Ontology, the Proxy Sensor Ontology, the Inferred Variable Ontology, and the Instrument Ontology for details.

Adding metadata only

You can add metadata easily on the wiki. The addition of metadata does not necessarily have to follow a publication. For instance, one LinkedEarth member can upload a legacy dataset in May 2017. In October 2017, another member, perhaps more familiar with the study, may add further information. As previously mentioned, the member, who originally updated the dataset, will receive an email that these pages have been changed. We anticipate such changes when not all the information, especially pertaining to instrumentation. uncertainty, or the physical sample, were available in the original manuscript.

Another example can involve the same contributor uploading the minimal required data and metadata in the haste to meet the journal requirements and deadlines and decide months later to add the recommended and desired metadata.

Adding data

Note: Adding data will automatically create new metadata.

If the updates involve extensive changes to measured variables, inferred variables, models (e.g, age model, calibration) following a new publication, we recommend creating a new LiPD file, and consequently a new dataset page. The new dataset should contain information relating to the first publication and a note explaining the relationships between the two datasets.

Compilation

The PartofCompilation Property can be used to link a particular dataset to a compilation, in which the dataset has been used (e.g., the PAGES2k compilation). To identify the particular variable used in the compilation, you can add a property to this particular variable to signal it's been used in the compilation (e.g., the PAGES2k consortium used the property UseInPAGES2kGlobalTemperatureAnalysis to identify the particular variable.

Nomenclature

Remember that (L) refers to a "core" or LiPD category/property in the LinkedEarth Ontology. As such, these categories and properties cannot be changed by basic editors on the wiki.