Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

Version 0.3 (on CRAN)

Compare
Choose a tag to compare
@leeper leeper released this 13 Oct 12:52
· 64 commits to master since this release

SIGNIFICANT USER-VISIBLE CHANGES

  • A print method has been added for dvDownloadInfo and the function additionally returns the raw value of the request. The return value of the function is otherwise unchanged.
  • dvSearch now supports both boolean AND and boolean OR logic to combine multiple search terms. See documentation.
  • dvAddFile no longer has a filesize argument (it being automatically calculated). The function now accepts filenames/paths (via filename) or dataframe names (via dataframe).
  • Support for the Data Deposit API has been added in the form of a dvDepositQuery workhorse function and some wrappers that search a user's dataverse(s): dvServiceDoc, dvUserStudies, dvStudyAtom, and dvStudyStatement. Functions to create, release, and delete studies are also supported: dvCreateStudy, dvReleaseStudy, and dvDeleteStudy.
    • From v0.2.7, improved error handling provides more parsed XML/HTML error messages when dvDepositQuery fails (#11)
    • From v0.2.65, added S3 print methods for almost all of the Data Deposit functions.
    • From v0.2.6, the Study Atom is converted to a list in all relevant functions, making it easier to extract a study's objectId.
    • From v0.2.6, dvUserStudies and dvStudyStatement return a list of values (for use in subsequent functions), in addition to the raw XML.
    • From v0.2.6, dvAddFile accepts either a .zip or a vector of filenames, which are compressed together before adding.
    • From v0.2.4, dataverse username and password can be set globally with options('dvn.user') and options('dvn.pwd').
    • From v0.2.35, dvEditStudy is also functional, along with both dvAddFile and dvDeleteFile.
  • The default dataverse (Harvard IQSS Dataverse) is now specified as a global option, which can be user-redefined with options('dvn').

BUG FIXES

  • Data Sharing API functions now attempt to fail gracefully when encountering unexpected API responses.
  • Fixed a url space encoding bug in dvSearch that prevented the use of multiple search terms.
  • Fixed a bug in dvDownload that failed to propagate the correct dataverse to dvDownloadInfo (h/t Egon Willighagen)

DOCUMENTATION

  • Documentation for dvDownloadInfo now provides more detail on its return value.
  • Capitalization of 'objectId' has been standardized throughout the package and documentation updated accordingly.
  • Package documenation now reports workflows for use of both the Data Sharing and Data Deposit APIs.