dvcurator.dataverse
===================

.. py:module:: dvcurator.dataverse


Functions
---------

.. autoapisummary::

   dvcurator.dataverse.get_metadata
   dvcurator.dataverse.get_citation
   dvcurator.dataverse.get_biblio_citation
   dvcurator.dataverse.download_dataset


Module Contents
---------------

.. py:function:: get_metadata(doi, token=None, host=None)

   Scrape all available metadata for a project from Dataverse

   :param doi: The persistent ID of the project (doi:xxxx/xxxxxx)
   :type doi: String
   :param token: Dataverse token, necessary if the project is unpublished
   :type token: String, or None
   :param host: Hostname of the dataverse instance (i.e. data.qdr.syr.edu), or None for the default
   :type host: String
   :return: Metadata block from Dataverse API, or None if error
   :rtype: list[str]


.. py:function:: get_citation(metadata)

   Extract and format the citation metadata block from the main metadata object

   :param metadata: Metadata block from `get_metadata()`
   :type metadata: list[str]
   :return: Index of metadata name:value combos
   :rtype: dict


.. py:function:: get_biblio_citation(doi, token=None, host=None)

   Get the recommended citation from Dataverse

   :param doi: The persistent ID of the project (doi:xxxx/xxxxxx)
   :type doi: String
   :param token: Dataverse token, necessary if the project is unpublished
   :type token: String, or None
   :param host: Hostname of the dataverse instance (i.e. data.qdr.syr.edu), or None for the default
   :type host: String
   :return: Recommended citation, as generated by dataverse
   :rtype: String


.. py:function:: download_dataset(metadata, folder, token=None, host=None)

   Download and extract dataset from Dataverse

   :param metadata: Metadata block from ```get_metadata()```
   :type metadata: list[str]
   :param token: Dataverse token, necessary if the project is unpublished
   :type token: String, or None
   :param host: Hostname of the dataverse instance (i.e. data.qdr.syr.edu), or None for the default
   :type host: String