add "review" dataset type #11747

Author: pdurbin

doc/release-notes/11747-review-dataset-type.md

@@ -0,0 +1,3 @@
+### New Dataset Type: Review
+
+A new, experimental dataset type called "review" has been added. When this type is published, it will be sent to DataCite as "Other" for resourceTypeGeneral. See #11747.

doc/sphinx-guides/source/api/native-api.rst

@@ -926,8 +926,8 @@ You should expect an HTTP 200 ("OK") response and JSON indicating the database I
 
 .. _api-create-dataset-with-type:
 
-Create a Dataset with a Dataset Type (Software, etc.)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Create a Dataset with a Dataset Type (Software, Workflow, Review, etc.)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 By default, datasets are given the type "dataset" but if your installation had added additional types (see :ref:`api-add-dataset-type`), you can specify the type.
 
@@ -981,8 +981,8 @@ Before calling the API, make sure the data files referenced by the ``POST``\ ed
 
 .. _import-dataset-with-type:
 
-Import a Dataset with a Dataset Type (Software, etc.)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Import a Dataset with a Dataset Type (Software, Workflow, Review, etc.)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 By default, datasets are given the type "dataset" but if your installation had added additional types (see :ref:`api-add-dataset-type`), you can specify the type.
 
@@ -3816,7 +3816,27 @@ The fully expanded example above (without environment variables) looks like this
 Add Dataset Type
 ^^^^^^^^^^^^^^^^
 
-Note: Before you add any types of your own, there should be a single type called "dataset". If you add "software" or "workflow", these types will be sent to DataCite (if you use DataCite). Otherwise, the only functionality you gain currently from adding types is an entry in the "Dataset Type" facet but be advised that if you add a type other than "software" or "workflow", you will need to add your new type to your Bundle.properties file for it to appear in Title Case rather than lower case in the "Dataset Type" facet.
+Note: Before you add any types of your own, there should be a single type called "dataset".
+
+Adding certain dataset types will result in a value other than "Dataset" being sent to DataCite (if you use DataCite) as shown in the table below.
+
+.. list-table:: Values sent to DataCite for resourceTypeGeneral by Dataset Type
+   :header-rows: 1
+   :stub-columns: 1
+   :align: left
+
+   * - Dataset Type
+     - Value sent to DataCite
+   * - dataset
+     - Dataset
+   * - software
+     - Software
+   * - workflow
+     - Workflow
+   * - review
+     - Other
+
+Other than sending a different resourceTypeGeneral to DataCite, the only functionality you gain currently from adding types is an entry in the "Dataset Type" facet but be advised that if you add a type other than "software", "workflow", or "review", you will need to add your new type to your Bundle.properties file for it to appear in Title Case rather than lower case in the "Dataset Type" facet.
 
 With all that said, we'll add a "software" type in the example below. This API endpoint is superuser only. The "name" of a type cannot be only digits. Note that this endpoint also allows you to add metadata blocks and available licenses for your new dataset type by adding "linkedMetadataBlocks" and/or "availableLicenses" arrays to your JSON.
 

doc/sphinx-guides/source/user/dataset-management.rst

@@ -824,11 +824,11 @@ Dataset Types
 
 .. note:: Development of the dataset types feature is ongoing. Please see https://github.com/IQSS/dataverse-pm/issues/307 for details.
 
-Out of the box, all datasets have a dataset type of "dataset". Superusers can add additional types such as "software" or "workflow" using the :ref:`api-add-dataset-type` API endpoint.
+Out of the box, all datasets have a dataset type of "dataset". Superusers can add additional types such as "software", "workflow", or "review" using the :ref:`api-add-dataset-type` API endpoint.
 
 Once more than one type appears in search results, a facet called "Dataset Type" will appear allowing you to filter down to a certain type.
 
-If your installation is configured to use DataCite as a persistent ID (PID) provider, the appropriate type ("Dataset", "Software", "Workflow") will be sent to DataCite when the dataset is published for those three types.
+If your installation is configured to use DataCite as a persistent ID (PID) provider, the appropriate type ("Dataset", "Software", "Workflow", "Review") will be sent to DataCite when the dataset is published for those types.
 
 Currently, specifying a type for a dataset can only be done via API and only when the dataset is created. The type can't currently be changed afterward. For details, see the following sections of the API guide:
 

src/main/java/edu/harvard/iq/dataverse/DataCitation.java

@@ -740,8 +740,11 @@ public Map<String, String> getDataCiteMetadata() {
 
     public JsonObject getCSLJsonFormat() {
         CSLItemDataBuilder itemBuilder = new CSLItemDataBuilder();
+        // TODO consider making this a switch
         if (type.equals(DatasetType.DATASET_TYPE_SOFTWARE)) {
             itemBuilder.type(CSLType.SOFTWARE);
+        } else if (type.equals(DatasetType.DATASET_TYPE_REVIEW)) {
+            itemBuilder.type(CSLType.REVIEW);
         } else {
             itemBuilder.type(CSLType.DATASET);
         }

src/main/java/edu/harvard/iq/dataverse/dataset/DatasetType.java

@@ -39,6 +39,7 @@ public class DatasetType implements Serializable {
     public static final String DATASET_TYPE_DATASET = "dataset";
     public static final String DATASET_TYPE_SOFTWARE = "software";
     public static final String DATASET_TYPE_WORKFLOW = "workflow";
+    public static final String DATASET_TYPE_REVIEW = "review";
     public static final String DEFAULT_DATASET_TYPE = DATASET_TYPE_DATASET;
 
     @Id

src/main/java/edu/harvard/iq/dataverse/pidproviders/doi/XmlMetadataTemplate.java

@@ -835,6 +835,8 @@ private void writeResourceType(XMLStreamWriter xmlw, DvObject dvObject) throws X
             case DatasetType.DATASET_TYPE_DATASET -> "Dataset";
             case DatasetType.DATASET_TYPE_SOFTWARE -> "Software";
             case DatasetType.DATASET_TYPE_WORKFLOW -> "Workflow";
+            // "Other" for now but we might ask DataCite to support https://schema.org/CriticReview 
+            case DatasetType.DATASET_TYPE_REVIEW -> "Other";
             default -> "Dataset";
             };
         }

src/main/java/propertyFiles/Bundle.properties

@@ -13,6 +13,7 @@ passwd=Password
 dataset=Dataset
 software=Software
 workflow=Workflow
+review=Review
 # END dataset types
 datasets=Datasets
 newDataset=New Dataset