In ropenscilabs/aspacer: Client for the ArchiveSpace API

aspacer

knitr::opts_chunk$set(
  comment = "#>",
  collapse = TRUE,
  warning = FALSE,
  message = FALSE,
  comment = "#>",
  fig.path = "README-"
)

ArchiveSpace API R client

ArchiveSpace API docs

Package status and installation

Installation instructions Development version

remotes::install_github("sckott/aspacer")

library("aspacer")

Usage

setup authentication

Login using asp_login(). Before logging in: You can pass in your username and password to the function. We strongly recommend not doing that though, and instead storing your credentials as environment variables, that are then read in within the package like Sys.getenv('ARCHIVESPACE_USER'). Store two env vars in your .Renviron file (create it if you don't have one): ARCHIVESPACE_USER and ARCHIVESPACE_PWD. You can alternatively use R options that are stored in your .Rprofile file as archivespace_user and archivespace_pwd, but env vars are preferred. You can optionally set env vars during the R session by running Sys.setenv(ARCHIVESPACE_USER = 'your user name') and Sys.setenv(ARCHIVESPACE_PWD = 'your password'), or similarly with R options like options(archivespace_user = 'your user name') and options(archivespace_pwd = 'your password') - but these only last for the current R session.

You can logout with asp_logout()

Search

Citation

Get citation information for aspacer in R by running: citation(package = 'aspacer')

Code of Conduct

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

ropenscilabs/aspacer documentation built on Sept. 3, 2020, 5:30 a.m.