Skip to contents

Get the SODAR project list table.

sodar_project_list.Rd

This function gets the SODAR project list table.

Usage

sodar_project_list(
  config = NULL,
  verbose = getOption("verbose", default = FALSE),
  return_raw = FALSE
)

Arguments

config

A list containing the SODAR configuration. If NULL, it tries to get it from the global options.

verbose

A logical value indicating whether to make verbose requests.

return_raw

A logical value indicating whether to return the raw response.

Value

A color data frame (colorDF) containing the SODAR project list.

Details

The function returns a data frame flavored by the colorDF package. This allows to hide multiline columns such as "readme", "roles" or "description". The columns are still present in the data frame and can be accessed as usual, but they are not shown in the console.