First pass at identifiers docs, addresses #2

microbiomedata · Mar 5, 2020 · 9e5333b · 9e5333b
1 parent e9912fe
commit 9e5333b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,3 +36,6 @@ We use [Jupyter notebooks](https://github.com/microbiomedata/nmdc-metadata/tree/
 
 Development of more comprehensive ETL pipeline will progress as the metadata sources and schema become more concrete.
 
+## Identifiers
+
+See [identifiers](docs/identifiers.md) documentation
diff --git a/docs/identifiers.md b/docs/identifiers.md
@@ -0,0 +1,24 @@
+# Identifiers in NMDC
+
+Identifiers are crucial for the NMDC, both for any data objects *created* and for any external objects *referenced*
+
+Examples of entities that require identifiers:
+
+ * Samples
+ * Data objects (e.g. sequence files)
+ * Taxa
+ * Genes
+ * Ontology terms and other descriptors
+
+Identifiers should be:
+
+ * Permanent
+ * Unique
+ * Resolvable
+ * Opaque
+
+See [McMurry et al, PMID:28662064](https://www.ncbi.nlm.nih.gov/pubmed/28662064) for more desiderata.
+
+
+
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,3 +36,6 @@ We use [Jupyter notebooks](https://github.com/microbiomedata/nmdc-metadata/tree/

		Development of more comprehensive ETL pipeline will progress as the metadata sources and schema become more concrete.

		## Identifiers

		See [identifiers](docs/identifiers.md) documentation