pyDataverse and other APIs
!!! The Python APIs for Dataverse are available via the PyCall and Conda package extensions. Documentation for these APIs is linked below.
- https://demo.dataverse.org
- https://pydataverse.readthedocs.io/en/latest/index.html
- https://guides.dataverse.org/en/5.11/api/index.html
Dataverse.pyDataverse.APIs
— MethodAPIs(;do_install=true,base_url = "https://dataverse.harvard.edu/")
(DataAccessApi,NativeApi)=pyDataverse.APIs()
Dataverse.pyDataverse.dataset_file_list
— Methoddataset_file_list(DOI::String="doi:10.7910/DVN/ODM2IQ")
Use NativeApi.get_dataset
to derive the list of files (name, etc) via files_to_DataFrame
.
dataset_file_list("doi:10.7910/DVN/ODM2IQ")
Dataverse.pyDataverse.dataset_file_list
— Methoddataset_file_list(nam::Symbol=:OCCA_clim)
Lookup DOI from list of demo data sets.
dataset_file_list(:OCCA_clim)
Dataverse.pyDataverse.dataverse_file_list
— Functiondataverse_file_list(nam::Symbol=:ECCOv4r2)
- Use
NativeApi.get_children
to get the tree of datasets - Loop through and return vector of
dataset_file_list
output
Dataverse.pyDataverse.demo
— Functiondemo(option::String)
- call
demo_download
ifoption=="download"
- call
demo_metadata
ifoption=="metadata"
Dataverse.pyDataverse.demo_download
— Methoddemo_download(;path=tempdir(),DOI = "doi:10.7910/DVN/KBHLOD")
Replicate the worflow example from
pyDataverse.demo_download()
Dataverse.pyDataverse.demo_metadata
— Methoddemo_metadata()
pyDataverse.demo_metadata()