set_url: Set 'Harmony' URL

In harmonydata: R Library for 'Harmony'

Set 'Harmony' URL

Description

This function sets the 'Harmony' API URL to be used in the package. By default, it uses the production 'Harmony' API ('https://api.harmonydata.ac.uk'), but you can override it by providing a different URL.

Usage

set_url(harmony_url = "https://api.harmonydata.ac.uk")

Arguments

harmony_url

The 'Harmony' API URL to be set. (default: 'https://api.harmonydata.ac.uk')

Details

The pkg.globals$url variable is a global variable that holds the 'Harmony' API URL to be used in the package. Once you set the URL using this function, it will be used in all the relevant functions within the package.

Value

No return value, called for side effects.

Author(s)

Ulster University [cph]

Examples

set_url('https://staging.harmonydata.org')
set_url() # Will set the URL back to the default 'https://api.harmonydata.ac.uk'

harmonydata documentation built on April 3, 2025, 6:33 p.m.