R Server Package

These resources apply to a single R package installed in the R server.

Description

GET /rserver/package/(string: name)

Get the description of the R package, i.e. all the entries from the DESCRIPTION file.

This entry point requires Authentication of a user with administrator or manager role.

Example requests

Using cURL

curl --user administrator:password https://rock-demo.obiba.org/rserver/package/rlang

Using R (rockr)

library(rockr)
conn <- rockr.connect(username="administrator", password="password", url = "https://rock-demo.obiba.org")
rockr.package(conn, "rlang")

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "name": "rlang",
  "Description": "A toolbox for working with base types, core R features\n  like the condition system, and core 'Tidyverse' features like tidy\n  evaluation.",
  "Enhances": "winch",
  "Built": "R 4.0.3; x86_64-pc-linux-gnu; 2021-02-22 08:25:16 UTC; unix",
  "License": "MIT + file LICENSE",
  "Imports": "utils",
  "ByteCompile": "true",
  "URL": "https://rlang.r-lib.org, https://github.com/r-lib/rlang",
  "RoxygenNote": "7.1.1",
  "BugReports": "https://github.com/r-lib/rlang/issues",
  "LazyData": "true",
  "Maintainer": "Lionel Henry <lionel@rstudio.com>",
  "Config/testthat/edition": "3",
  "Version": "0.4.10",
  "Suggests": "cli, covr, crayon, glue, magrittr, methods, pak, pillar,\nrmarkdown, testthat (>= 3.0.0), vctrs (>= 0.2.3), withr",
  "NeedsCompilation": "yes",
  "Authors@R": "c(\n    person(\"Lionel\", \"Henry\", ,\"lionel@rstudio.com\", c(\"aut\", \"cre\")),\n    person(\"Hadley\", \"Wickham\", ,\"hadley@rstudio.com\", \"aut\"),\n    person(given = \"mikefc\",\n           email = \"mikefc@coolbutuseless.com\", \n           role = \"cph\", \n           comment = \"Hash implementation based on Mike's xxhashlite\"),\n    person(given = \"Yann\",\n           family = \"Collet\",\n           role = \"cph\", \n           comment = \"Author of the embedded xxHash library\"),\n    person(\"RStudio\", role = \"cph\")\n    )",
  "Date/Publication": "2020-12-30 15:00:02 UTC",
  "Packaged": "2020-12-18 09:35:30 UTC; lionel",
  "Biarch": "true",
  "Title": "Functions for Base Types and Core R and 'Tidyverse' Features",
  "Encoding": "UTF-8",
  "Repository": "CRAN",
  "Author": "Lionel Henry [aut, cre],\n  Hadley Wickham [aut],\n  mikefc [cph] (Hash implementation based on Mike's xxhashlite),\n  Yann Collet [cph] (Author of the embedded xxHash library),\n  RStudio [cph]",
  "Package": "rlang",
  "Depends": "R (>= 3.3.0)"
}

Response JSON Object

name (string) – R package name.
<field> (string) – Field value from the DESCRIPTION file.

Request Headers

Authorization – As described in the Authentication section
Accept – */*

Response Headers

Content-Type – application/json

Status Codes

200 OK – Server is alive and functional.
401 Unauthorized – User is not authenticated.
403 Forbidden – User does not have the appropriate role for this operation.
404 Not Found – Package with provided name could not be found.
500 Internal Server Error – Package description could not be retrieved, when R server is not running for instance.

Remove

DELETE /rserver/package/(string: name)

Remove the R package.