Package 'aurora'

Title: Interface to the Oxford University Research Archive
Description: The Oxford University Research Archive (ORA) <https://ora.ox.ac.uk/> 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 <https://ora.ox.ac.uk/api>.
Authors: Ernest Guevarra [aut, cre]
Maintainer: Ernest Guevarra <[email protected]>
License: GPL (>= 3)
Version: 0.0.0.9000
Built: 2025-02-17 03:44:36 UTC
Source: https://github.com/OxfordIHTM/aurora

Help Index


Retrieve information about Oxford University OAI repository

Description

Retrieve information about Oxford University OAI repository

Usage

ora_identify(base_url = "https://ora.ox.ac.uk/oai2", tabular = TRUE)

Arguments

base_url

The OAI-PMH endpoint base URL. Set to https://ora.ox.ac.uk/oai2.

tabular

Logical. Should response be structured into a table? Default is TRUE.

Value

A data.frame (default) or an XML document (if tabular = FALSE) with identifying information on the OAI repository.

Examples

ora_identify()

List metadata formats

Description

List metadata formats

Usage

ora_list_meta_formats(base_url = "https://ora.ox.ac.uk/oai2", tabular = TRUE)

Arguments

base_url

The OAI-PMH endpoint base URL. Set to https://ora.ox.ac.uk/oai2.

tabular

Logical. Should response be structured into a table? Default is TRUE.

Value

A data.frame (default) or an XML document (if tabular = FALSE) with identifying information on the OAI metadata formats.

Examples

ora_list_meta_formats()

List records

Description

List records

Usage

ora_list_records(
  base_url = "https://ora.ox.ac.uk/oai2",
  metadata_prefix = c("oai_dc", "datacite_dc", "dart_dc", "solo_dc", "base_dc",
    "oai_openaire", "uketd_dc", "rioxx_terms", "rioxx_terms_cc0")
)

ora_list_records_id(
  base_url = "https://ora.ox.ac.uk/oai2",
  metadata_prefix = c("oai_dc", "datacite_dc", "dart_dc", "solo_dc", "base_dc",
    "oai_openaire", "uketd_dc", "rioxx_terms", "rioxx_terms_cc0")
)

Arguments

base_url

The OAI-PMH endpoint base URL. Set to https://ora.ox.ac.uk/oai2

metadata_prefix

Prefix or code for metadata format to retrieve for each record returned. List of all the metadata formats supported can be retrieved through a call to ora_list_metadata_formats(). Default is "oai_dc" for the OAI-PMH standard Dublin Core (DC).

Value

XML OAI response

Metadata Format

Metadata for each item (record) is available in several formats. Not all formats are supported for all records.

Examples

ora_list_records()
ora_list_records_id()

List sets of work

Description

List sets of work

Usage

ora_list_sets(base_url = "https://ora.ox.ac.uk/oai2")

Arguments

base_url

The OAI-PMH endpoint base URL. Set to https://ora.ox.ac.uk/oai2

Value

XML OAI response

List Sets

ORA records are available for selective harvesting as a separate set based on their Type of work within the ORA system, e.g. "thesis", "dataset", "journal article".

Examples

ora_list_sets()

Structure ORA XML outputs

Description

Structure ORA XML outputs

Usage

ora_structure_identify(ora_xml)

ora_structure_meta_formats(ora_xml)

Arguments

ora_xml

XML outputs.

Value

A tibble outputs.

Examples

ora_identify()
ora_list_meta_formats()