set_api_url {rspacer}R Documentation

Set the RSPACE_API_URL environment variable

Description

Sets the RSPACE_API_URL environment variable to the provided RSpace API URL. The RSpace API URL is likely the URL of your RSpace instance followed by api/v1.

Usage

set_api_url(rspace_api_url)

Arguments

rspace_api_url

The RSpace API URL

Details

This will only set the environment variable for the current session, to set it permanently, add ⁠RSPACE_API_URL=<your_api_url_here>⁠ to your .Renviron file, for example, using usethis::edit_r_environ().

Value

A logical indicating if setting the API URL succeeded.

Examples

## Not run: 
set_api_url("https://leiden.researchspace.com/api/v1")

## End(Not run)

[Package rspacer version 0.2.0 Index]