Get the list of CAX datasets (tables) with ids

Source: R/rcax_datasets.R

Get the list of CAX datasets (tables) with ids

rcax_datasets(
  cols = c("name", "id", "description"),
  GETargs = list(table_id = NULL, recordloc = "records", key = NULL, parse = TRUE),
  ...
)

Arguments

cols

the columns to return. default is name, description and id. use cols=NULL to get all the columns

GETargs

A list of arguments for the rcax_GET() call. These do not need to be specified by the user unless the user wants to change the default values. table_id This is the CAX table id. It is looked up using tablename and rCAX:::caxpops (an internal dataset). If table_id is passed in via GETargs, it will override the default table id lookup. recordloc This is the name of the record we want in the list returned from the GET call. key is the API key.

...

Curl options passed to HttpClient

Examples

a <- rcax_datasets(cols=NULL)
colnames(a)
#>  [1] "can_delete"     "name"           "can_update"     "lastmodifiedby"
#>  [5] "primary_key"    "description"    "can_append"     "lastmodifiedon"
#>  [9] "count"          "id"             "can_read"       "type"          

head(a[,1:2])
#>   can_delete                         name
#> 1          0             SuperPopulations
#> 2          0                  XPortCA_PNI
#> 3          0                  EscData4GIS
#> 4          1             HatcheryReleases
#> 5          0 XPortCA_PresmoltAbundance_01
#> 6          1              HatcheryProgram