| Title: | R Wrapper Around The RStudio Package Manager API |
|---|---|
| Description: | Provides functions for querying the RStudio Package Manager API. If your oraganisation uses RStudio Packaeg Manager, this package will allow you to interact with it's API directly from R without having to construct the queries manually. |
| Authors: | Mark Sellors [aut, cre] |
| Maintainer: | Mark Sellors <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.0.0.9000 |
| Built: | 2024-11-01 04:23:48 UTC |
| Source: | https://github.com/sellorm/rspmapi |
Fetches a list of alerts for events such as excessive file usage
alerts(instance)alerts(instance)
instance |
An rspm_instance object created with |
Connect to an RStudio Package Manager instance
instance(url, silent = FALSE)instance(url, silent = FALSE)
url |
string The URL of the Package Manager instance |
silent |
boolean Silences the connection status message |
This API takes two possible parameters resulting in a URL of the form:
/__api__/metrics/packages?_sourceType=r&_days=7
metrics_packages(instance, params = list())metrics_packages(instance, params = list())
instance |
An rspm_instance object created with |
params |
A list of optional query parametes |
Fetches lists of repositories
repos(instance, params = list())repos(instance, params = list())
instance |
An rspm_instance object created with |
params |
A list of optional parameters applied to the API query |
Fetches the date of the earliest calendar transaction for a repo. Considers only transactions that are viable for calendar-based snapshots.
repos_first_transaction(instance, id)repos_first_transaction(instance, id)
instance |
An rspm_instance object created with |
id |
An RSPM repository ID |
Fetches a single package for a specific repository with optional parameters
repos_packages(instance, id, name = NULL, params = list())repos_packages(instance, id, name = NULL, params = list())
instance |
An rspm_instance object created with |
id |
An RSPM repository ID |
name |
A package name |
params |
A list of optional parameters applied to the API query |
Fetches lists of system requirements for a specific repository and package
repos_packages_sysreqs(instance, id, name, params = list())repos_packages_sysreqs(instance, id, name, params = list())
instance |
An rspm_instance object created with |
id |
An RSPM repository ID |
name |
A package name |
params |
A list of optional parameters applied to the API query |
Fetches lists of source records for a specific repository
repos_sources(instance, id, params = list())repos_sources(instance, id, params = list())
instance |
An rspm_instance object created with |
id |
An RSPM repository ID |
params |
A list of optional parameters applied to the API query |
Fetches list of system requirements for a specific repository
repos_sysreqs(instance, id, params = list())repos_sysreqs(instance, id, params = list())
instance |
An rspm_instance object created with |
id |
An RSPM repository ID |
params |
A list of optional parameters applied to the API query |
builds appropriate query strings and performs requests against the supplied RSPM instance
return_endpoint(instance, endpoint, params = list())return_endpoint(instance, endpoint, params = list())
instance |
An RSPM instance object created with |
endpoint |
The API endpoint to query |
params |
Optional list of query parameters |
Fetches lists of sources available in RSPM
sources(instance)sources(instance)
instance |
An rspm_instance object created with |
Fetches lists of packages for a specific source with optional filters
sources_packages(instance, id, params = list())sources_packages(instance, id, params = list())
instance |
An rspm_instance object created with |
id |
An RSPM source ID |
params |
A list of optional parameters applied to the API query |
Fetches lists of PyPI package releases for a specific package name and source with optional filters
sources_packages_releases(instance, id, name, params = list())sources_packages_releases(instance, id, name, params = list())
instance |
An rspm_instance object created with |
id |
An RSPM source ID |
name |
A package name |
params |
A list of optional parameters applied to the API query |
Fetches lists of transactions for a given source
sources_transactions(instance, id, params = list())sources_transactions(instance, id, params = list())
instance |
An rspm_instance object created with |
id |
An RSPM source ID |
params |
A list of optional parameters applied to the API query |
Fetches the status of the RStudio Package Manager server
status(instance)status(instance)
instance |
An rspm_instance object created with |