Citing PDS4 Data

Overview

This page gives guidelines for providers to ensure sufficient information is available for future citations of their data, and guidelines for data users regarding how to cite PDS Data.

Researchers: Citing PDS data for imminent publications

This section is for those researchers who are preparing a scientific paper and wish to cite the PDS data used in their research in order to (a) ensure that other researchers will be able to find precisely the data used, and (b) give credit to those who prepared, curated, and archived the data.

The actual format of the citation(s) will be dependent on the journal publisher. Here we discuss the information you will want to include and where to find it.

Getting Started

The following information describes how to cite PDS4 data. For PDS3 Data, see the Citing PDS3 Data page.

Not sure if the data you are looking to cite is PDS3 or PDS4? See the How-To Guide below.

Citing PDS4 Data

The PDS uses LIDVIDsInfo icon for terminology, LIDVID to uniquely identify every PDS4 BundleInfo icon for terminology, bundle, PDS4 CollectionInfo icon for terminology, collection, observational data product, document, etc., within the internal system. In addition to the LIDVID, the PDS uses Digital Object Identifiers (DOIs) External link icon for connecting research data products to the greater body of scientific knowledge. DOIs are assigned to every PDS4 BundleInfo icon for terminology, bundle, and, when appropriate, to some PDS4 CollectionsInfo icon for terminology, collection and Documents.

The general principle for citing PDS4 data using DOIs is to cite the most granular product you can. The following table summarizes the granularity of products in PDS4, as well as the frequency at which DOIs are assigned to those products. The remaining guide will provide more details on finding these DOIs and how to cite the LIDVIDs for the products used in the research.

Granularity Product DOI Assignment Frequency
Finest Data Products and Documents DOIs are only routinely assigned to Document products at this time.
Medium Collections DOIs are assigned to some Collections.
Least Bundles DOIs are assigned to all Bundles.

Not sure what some of these terms mean? See Terminology and Acronyms section below.

Learn more about the PDS Digital Object Identifier (DOI) Policy.

Example Use Cases

Below we describe some example use cases for guidance:

If you are in need of more assistance, please contact the PDS Help Desk External link icon.

Case 1: You used all data products from a single bundle or collection.

Using the general principle of citing the most granular product you can, the formal citation should be to the applicable bundle or collection (if a DOI exists).

Helpful Guides
Example of citation

The following is an example APA citation for the InSight Lander Radiometer Bundle using https://citation.crosscite.org/ External link icon: 

InSight RAD Science Team. (2019). Mars InSight Lander Radiometer Data Archive. PDS Geosciences (GEO) Node. https://doi.org/10.17189/1517568

See https://citation.crosscite.org/ External link icon for recommendations for bundle DOI citation in various formats. Bibtex users may need to modify the crosscite-produced bibtex to produce optimal results.

Case 2: You used a relatively small number of data products from a single bundle.

The formal citation should be to the bundle, with individual products listed by LIDVID as a table within the paper, or as an appendix to the paper.

Helpful Guides
Helpful Guides

The following is an example APA citation for the InSight Lander Radiometer Bundle using https://citation.crosscite.org/ External link icon: 

InSight RAD Science Team. (2019). Mars InSight Lander Radiometer Data Archive. PDS Geosciences (GEO) Node. https://doi.org/10.17189/1517568
Example of table of LIDVIDs

The following is an example appendix providing a table of LIDVIDs of data products from e InSight Lander Radiometer Bundle: 

Appendix - Citation of PDS Data products

PDS4 data products cited in this paper as part of https://doi.org/10.17189/1517568 include:
urn:nasa:pds:insight_rad:data_derived:hp3_rad_der_00305_20191006_053040::1.0
urn:nasa:pds:insight_rad:data_derived:hp3_rad_der_00390_20200101_120222::1.0
urn:nasa:pds:insight_rad:data_derived:hp3_rad_der_00478_20200401_121608::1.0

See https://citation.crosscite.org/ External link icon for recommendations for bundle DOI citation in various formats. Bibtex users may need to modify the crosscite-produced bibtex to produce optimal results.

Case 3: The number of PDS data products you used is too large to be reasonably accommodated within your scientific paper or abstract using the methods in case 1.

Please cite the bundle(s) or collection(s) from which you extracted data. Additionally, describe in the text of the paper, in an appendix, or in the citation itself, some additional context to help ensure future researchers can find all of the supporting material (e.g., a time range, specific map features, processing level).

If necessary, contact the PDS Help Desk External link icon or work with your curating node for possible alternatives.

Helpful Guides
Example of citation with additional context

The following is an example citation for the InSight Cameras Bundle using https://citation.crosscite.org/ External link icon: 

Insight Mars SEIS Data Service. (2019). InSight SEIS Data Bundle. PDS Geosciences (GEO) Node. https://doi.org/10.17189/1517570

The following is an example of providing additional citation context in an appendix as a means to help enable reproducibility of the analysis. This context could also be provided elsewhere in the paper. 

Appendix - PDS Product Citation Addendum

375 PDS data products from the InSight Seismic Experiment for Interior Structure (SEIS) Instrument were used for the analysis contained within this paper. The PDS Geosciences Node InSight Analyst's Notebook (https://an.rsl.wustl.edu/ins/an/an3.aspx) was used to search and find the applicable products within the sol range of 430 to 435.
Case 4: Some bundles contain multiple data collections prepared by different teams.

(Think of a book with different authors for each chapter). In this case, only cite the appropriate collections. The relationship between the bundle and the collection will be traced via the DOI metadata. Unless you used every data product in the collection and provided that information explicitly in your paper, you also will need to provide the LIDVIDs of the individual products as described above.

Helpful Guides
Example of citation

The following is an example APA citation for the MAVEN Langmuir Probe and Waves Data Collection using https://citation.crosscite.org/ External link icon: 

Andersson, L. (2017). MAVEN Langmuir Probe and Waves (LPW) Raw Wave Active Sub-Cycle Potentials Data Collection [Data set]. PDS Planetary Plasma Interactions (PPI) Node. https://doi.org/10.17189/1414202

Data Providers: Providing information for future citations of your data

We recommend that you:

  • Get familiar with PDS Digital Object Identifier (DOI) Policy.
  • Coordinate early with your curating node (see list of PDS node contacts) to obtain reserved Digital Object Identifiers (DOIs) – for your bundle, your data collections if appropriate, and key documents you are publishing via the data submission (e.g., Users Guide).
  • Populate the Citation_Information class in the bundle XML file (and if appropriate, in the data collection XML and/or document XML label), as completely as possible.
  • Need a DOI for your PDS Data or need to update the metadata? Contact the PDS Help Desk External link icon or your curating node (see list of PDS node contacts).

How-to Guides

How to determine if the data is PDS3 or PDS4

There are several ways to determine if the data you are using is PDS3 or PDS4 depending upon the data files you are using.

For starters, looking at the file extensions in any directory of data set, or for the specific metadata labels for the data products you are looking to cite:

  • If .xml file extensions are present (e.g. my_pds4_label.xml), it is most likely PDS4.
  • If .xml is not present and .lbl file extensions are present (e.g. my_pds3_label.lbl), it is most likely PDS3.
  • If both are present:
    • Look for a bundle.xml file (or some file name containing bundle and ending in .xml). If it is present, it’s PDS4.
    • Or open any of the .xml files and search for the following URL http://pds.nasa.gov/pds4/pds/ (the PDS Namespace Reference). If present, it’s PDS4.

Still not sure? Contact the PDS Help Desk External link icon for assistance.

How to find the bundle(s) to which a set of products belongs

You can extract the applicable PDS4 Bundle LIDVID using the logical identifier(s) (LIDs) of the products being cited.

  1. Find the logical identifier within each product, for instance, the logical identifier (LID) from this InSight Camera’s product label External link icon (C000M0300_623161840EDR_F0000_0461M2.xml) (Note: Value has been shortened from actual): 
    <Identification_Area>
    <logical_identifier/>u:n:p:ic:d:c000m0300_623161840edr_f0000_0461m</logical_identifier>
    <version_id>2.0</version_id>
    <title>InSight ICC EDR Observational Product</title>
    <information_model_version>1.11.1.0</information_model_version>
    <product_class>Product_Observational</product_class>
  2. Per the PDS4 LID formation rule: 
    urn:nasa:pds:<bundle_id>:<collection_id>:<product_id>
    You can extract the bundle identifier like so: 
    Product LID: urn:nasa:pds:insight_cameras:data:c000m0300_623161840edr_f0000_0461m
Bundle LID: urn:nasa:pds:insight_cameras
  3. Follow the steps for finding the DOI for a PDS4 Bundle.
  4. If you are unable to find the DOI for the PDS4 Bundle, please contact the PDS Help Desk External link icon for assistance.

How to find the DOI for a PDS4 bundle

Using the LIDVID of the PDS4 Bundle, go to PDS DOI Search Portal and search to find the applicable DOI.

Don’t know the LIDVID of the PDS4 Bundle?

How to find the DOI for a PDS4 collection

Using the LIDVID of the PDS4 Collection, go to PDS DOI Search Portal and search to find the applicable DOI. If one does not exist, you will need to cite the parent PDS4 Bundle instead, see above.

Don’t know the LIDVID of the PDS4 Collection?

How to find the DOI for a PDS4 document

Using the LIDVID of the PDS4 Document, go to PDS DOI Search Portal and search to find the applicable DOI. If one does not exist, you can request that one be minted by contacting the PDS Help Desk External link icon.

Don’t know the LIDVID of the PDS4 Document?

How to find a PDS4 LIDVID

All PDS4 products contain a logical identifier (LID) and version identifier (VID). In all PDS4 labels, these can be found within the Identification_Area of the label and combined to form the LIDVID. For example, using this Maven bundle product here External link icon, you will see an identification area within the label: 

<Identification_Area>
  <logical_identifier>urn:nasa:pds:maven.anc</logical_identifier> <!--- LID --->
  <version_id>2.1</version_id>					  <!--- VID --->
  <title>MAVEN Ancillary Bundle</title>
  <information_model_version>1.13.0.0</information_model_version>
  <product_class>Product_Bundle</product_class>

You then combine these two values, separated by two semi-colons (::) to form the LIDVID: 

urn:nasa:pds:maven.anc::2.1

Is a how-to guide or FAQ missing from this list?

Please contact the PDS Help Desk External link icon for assistance.

Terminology and Acronyms

Below are some basic terminology descriptions used on the page above. For more terminology and detailed information, see the PDS4 Concepts document.

  • LID - A logical identifier (LID) is uniquely associated with the set of all versions of a Product. See Section 6D.2 of the Standards Reference for more information on uniquely identifying Products.

  • LIDVID - The combination of the logical identifier (LID) and version identifier (VID). Every product in a PDS4 archive has a unique LID. When a product is revised, its LID remains constant but its VID is incremented. e.g.: 
    urn:nasa:pds:bopps2014:calibrated:ceha_1_024109424_n011_0244e_fit::1.0
    See Section 6D.3 of the Standards Reference for more information on versioning Products.

  • Collection - Products are grouped into ‘collections’ by type and content. Observational data, for example, may be gathered into an observational data collection, documents into a document collection, and supplementary data into a supplementary collection. The collection label, like any other label, contains a logical identifier that is unique across the entire PDS. Example collection label: https://pds-rings.seti.org/pds4/bundles/cassini_iss_saturn/data_raw/collection_data_raw.xml External link icon.
    See Section 2A.2 of the Standards Reference for more information on Collections.

  • Bundle - Collections are themselves gathered into bundles. Small archives may have a single bundle containing all of the collections. Larger archives will be broken into bundles along some convenient lines (mission phase, source instrument, review schedule, etc.). Example bundle label: https://pds-rings.seti.org/pds4/bundles/cassini_iss_saturn/bundle.xml External link icon. See the guide for How to find the bundle(s) to which a set of products belongs.
    See Section 2A.1 of the Standards Reference for more information on Bundles.

  • local identifier - A local identifier is unique within a label. It can be assigned to distinct parts of the label (e.g., Table _Binary) to simplify cross-referencing within the label.

  • Products - A ‘basic product’ is the simplest product in PDS4; it is one or more data objects (and their label), which constitute (typically) a single observation, document, etc. Examples of observational data products are images, spectra, maps, shape models, tables with ensemble information, etc. Examples of documents are mission overview, data user guides, software interface specifications (SIS), calibration information, thumbnails etc.