Add dataset types to Dataset and Dataverse
#52
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a new feature that allows users to specify the type of dataset when creating one. This functionality was first introduced in the Dataverse 6.4 release. Users can now set the
dataset_typeattribute on aDatasetinstance. Upon assignment, the validity of the dataset type is checked by calling theapi/datasets/datasetTypesendpoint.Additionally, users can inspect the available dataset types by using the
list_dataset_typesmethod or thedataset_typesmethod once connected to aDataverseinstance or class. While thelist_dataset_typesmethod is primarily intended for printing purposes, thedataset_typesmethod provides a more detailed response from theapi/datasets/datasetTypesendpoint, allowing for a more comprehensive access to the dataset type.Since this is a relatively new feature, version checks are performed upon assignment, and unsupported versions will simply skip the dataset type logic. Tests have been added to verify the functionality of this new feature.
Example
For an interactive version, checkout this Colab Notebook.
Closes