Wrapper for Objective APIs • objr

objr aims to provide a convenient method of interacting with Objective Connect using R, making use of the Objective Connect API.

Installation

If you are working within the Scottish Government network, you can install objr in the same way as with other R packages. The easiest way to do this is by using the pkginstaller add-in. Further guidance is available on eRDM.

Alternatively, objr can be installed directly from GitHub. Note that this method requires the remotes package and may not work from within the Scottish Government network.

remotes::install_github(
  "ScotGovAnalysis/objr",
  upgrade = "never",
  build_vignettes = TRUE
)

Finally, objr can also be installed by downloading the zip of the repository and running the following code, replacing the section marked <> (including the arrows themselves) with the location of the downloaded zip:

remotes::install_local(
  "<FILEPATH OF ZIPPED FILE>/objr-main.zip",
  upgrade = "never",
  build_vignettes = TRUE
)

Getting Started

Once installed, objr can be loaded using the library() function:

library(objr)

Help files for each function in the package can be found on the References page of the package website. Alternatively, type ?function_name into the RStudio console. For example:

?workspaces()

There is also a demonstration of a simple workflow using the package in vignette("objr").

Licence

Unless stated otherwise, the codebase is released under the MIT Licence. This covers both the codebase and any sample code in the documentation.