db_set_key: Function to set a key for accessing the live OR Extended...

View source: R/keys.R

db_set_keyR Documentation

Function to set a key for accessing the live OR Extended database

Description

This function adds your key to your .Renviron so it is accessible by db_key(). You should only need to run this function once. Make sure to restart your local R session after running this function for the changes to take effect.

Usage

db_set_key(key, overwrite = FALSE)

Arguments

key

A string of your specific key

overwrite

Defaults to FALSE. If there is a key already in the .Renviron, should it be overwritten?

Value

A message or warning

Examples

library(orextdb)

## Not run: 
db_set_key("abcdefghikjlmnop")

## End(Not run)

UO-BRT/orextdb documentation built on Jan. 29, 2023, 8:53 a.m.