Skip to contents

aurora: Interface to the Oxord University Research Archive (ORA) API

The Oxford University Research Archive (ORA) is an Open Access platform and is the institutional repository for the University of Oxford. ORA serves as a permanent and secure online archive of research materials produced by members of the University of Oxford. ORA supports and participates in the Open Archives Initiative (OAI). ORA is a registered OAI-PMH data-provider and provides metadata for all public records which is updated as soon as each record is published or updated. ORA also provides API access to its resources. This package provides low level functions to interface with the ORA API.

What does aurora do?

Please note that aurora is still highly experimental and is undergoing a lot of development. Hence, any functionalities described below and in the rest of the package documentation have a high likelihood of changing interface or approach as we aim for a stable working version.

Currently, the package provides functions that wrap each of the verb request endpoints provided by OAI 2.0:

  • Identify
  • ListRecords
  • ListSets
  • ListMetadataFormats
  • ListIdentifiers

From here, the plan is to develop functions that structure these XML OAI responses into tabular formats useful for analysis.

Installation

aurora is not yet on CRAN but can be installed from the Oxford iHealth R Universe as follows:

install.packages(
  "aurora",
  repos = c('https://oxfordihtm.r-universe.dev', 'https://cloud.r-project.org')
)

Usage

Citation

If you find the aurora package useful please cite using the suggested citation provided by a call to the citation() function as follows:

citation("aurora")
#> To cite aurora in publications use:
#> 
#>   Ernest Guevarra (2024). _aurora: Interface to the Oxord University
#>   Research Archive (ORA) API_. R package version 0.0.9000,
#>   <https://oxford-ihtm.io/aurora/>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {aurora: Interface to the Oxord University Research Archive (ORA) API},
#>     author = {{Ernest Guevarra}},
#>     year = {2024},
#>     note = {R package version 0.0.9000},
#>     url = {https://oxford-ihtm.io/aurora/},
#>   }

Community guidelines

Feedback, bug reports and feature requests are welcome; file issues or seek support here. If you would like to contribute to the package, please see our contributing guidelines.

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.