Added data_access module for managed access data. Fixes #1535

docs/jsonBrowser/module.md

@@ -346,6 +346,16 @@ text | The text for the term as the user provides it. | string | yes |  | Organ
 ontology | An ontology term identifier in the form prefix:accession. | string | no |  | Organ ontology ID |  | UBERON:0000948; UBERON:0002405
 ontology_label | The preferred label for the ontology term referred to in the ontology field. This may differ from the user-supplied value in the text field. | string | no |  | Organ ontology label |  | heart; immune system
 
+## Data access<a name='Data access'></a>
+_Information about the data access type for the project._
+
+Location: module/project/data_access.json
+
+Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example 
+--- | --- | --- | --- | --- | --- | --- | --- 
+type | Type of data access permissions associated with this project. | string | yes |  | Data access type | All fully open, All managed access, A mixture of open and managed, Complicated/see notes | 
+notes | Notes regarding data access type | string | no |  | Data access notes |  | This dataset can only be accessed through contact with the authors
+
 ## Funder<a name='Funder'></a>
 _Information about the project funding source._
 

docs/jsonBrowser/required_fields.md

@@ -147,6 +147,7 @@ Property name | Description | Type | Object reference? | User friendly name | Al
 schema_type | The type of the metadata schema entity. | string |  |  | project | 
 project_core | Core project-level information. | object | [See core  project_core](core.md#project-core) | Project core |  | 
 funders | Funding source(s) supporting the project. | array | [See module  funder](module.md#funder) | Funding source(s) |  | 
+data_access | Information about the data access type for the project. | object | [See module  data_access](module.md#data-access) | Data access |  | 
 ### Specimen from organism
 Property name | Description | Type | Object reference? | User friendly name | Allowed values | Example 
 --- | --- | --- | --- | --- | --- | --- 
@@ -327,6 +328,10 @@ text | The name of a cell type supplied by a user. | string |  | Cell type |  |
 Property name | Description | Type | Object reference? | User friendly name | Allowed values | Example 
 --- | --- | --- | --- | --- | --- | --- 
 text | The text for the term as the user provides it. | string |  | Organ |  | heart; immune system
+### Data access<a name='Data access'></a>
+Property name | Description | Type | Object reference? | User friendly name | Allowed values | Example 
+--- | --- | --- | --- | --- | --- | --- 
+type | Type of data access permissions associated with this project. | string |  | Data access type | All fully open, All managed access, A mixture of open and managed, Complicated/see notes | 
 ### Funder<a name='Funder'></a>
 Property name | Description | Type | Object reference? | User friendly name | Allowed values | Example 
 --- | --- | --- | --- | --- | --- | --- 

docs/jsonBrowser/type.md

@@ -326,6 +326,7 @@ insdc_study_accessions | An International Nucleotide Sequence Database Collabora
 biostudies_accessions | A BioStudies study accession. | array | no |  | BioStudies accession |  | S-EXMP1; S-HCAS33
 funders | Funding source(s) supporting the project. | array | yes | [See module  funder](module.md#funder) | Funding source(s) |  | 
 estimated_cell_count | An estimated number of cells in this project | integer | no |  | Estimated cell count |  | 10000; 2100000
+data_access | Information about the data access type for the project. | object | yes | [See module  data_access](module.md#data-access) | Data access |  | 
 
 ## Specimen from organism
 _Information about the specimen that was collected from the donor organism._

json_schema/module/project/data_access.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Information about the data access type for the project.",
+  "additionalProperties": false,
+  "required": [
+    "type"
+  ],
+  "if": {
+    "properties": {
+      "type": {
+        "const": "Complicated/see notes"
+      }
+    }
+  },
+  "then": {
+    "required": [
+      "notes"
+    ]
+  },
+  "title": "Data access",
+  "name": "data_access",
+  "type": "object",
+  "properties": {
+    "describedBy": {
+      "description": "The URL reference to the schema.",
+      "type": "string",
+      "pattern" : "^(http|https)://schema.(.*?)humancellatlas.org/module/project/(([0-9]{1,}.[0-9]{1,}.[0-9]{1,})|([a-zA-Z]*?))/data_access"
+    },
+    "schema_version": {
+      "description": "The version number of the schema in major.minor.patch format.",
+      "type": "string",
+      "pattern": "^[0-9]{1,}.[0-9]{1,}.[0-9]{1,}$",
+      "example": "4.6.1"
+    },
+    "type": {
+      "description": "Type of data access permissions associated with this project.",
+      "type": "string",
+      "enum": [
+        "All fully open",
+        "All managed access",
+        "A mixture of open and managed",
+        "Complicated/see notes"
+      ],
+      "guidelines": "Must be one of: All fully open,All managed access,A mixture of open and managed,Complicated/see notes",
+      "user_friendly": "Data access type"
+    },
+    "notes": {
+      "description": "Notes regarding data access type",
+      "type": "string",
+      "example": "This dataset can only be accessed through contact with the authors",
+      "user_friendly": "Data access notes"
+    }
+  }
+}

json_schema/property_migrations.json

@@ -1,5 +1,13 @@
 {
     "migrations": [
+        {
+            "source_schema": "project",
+            "property": "data_access",
+            "effective_from": "18.0.0",
+            "reason": "Data access is now recorded as a mandatory field",
+            "type": "new required property"
+
+        },
         {
             "source_schema": "cell_line",
             "property": "timecourse",

json_schema/type/project/project.json

@@ -6,7 +6,8 @@
         "describedBy",
         "schema_type",
         "project_core",
-        "funders"
+        "funders",
+        "data_access"
     ],
     "title": "Project",
     "name": "project",
@@ -164,6 +165,12 @@
             "type": "integer",
             "example": "10000; 2100000",
             "user_friendly": "Estimated cell count"
+        },
+        "data_access": {
+            "description": "Information about the data access type for the project.",
+            "type": "object",
+            "$ref": "module/project/data_access.json",
+            "user_friendly": "Data access"
         }
     }
 }

json_schema/update_log.csv

@@ -1 +1,3 @@
 Schema,Change type,Change message,Version,Date
+type/project/project,major,"Added data_access field",,
+module/project/data_access,major,"Added data_access module",,

json_schema/versions.json

@@ -73,7 +73,8 @@
                 "contact": "9.0.0",
                 "funder": "2.0.0",
                 "hca_bionetwork": "1.0.1",
-                "publication": "7.0.0"
+                "publication": "7.0.0",
+                "data_access": "0.0.0"
             },
             "protocol": {
                 "channel": "2.0.4",