protobi_get_table_details: Get data table details

In protobi/protobi-r: Protobi R Library

Get data table details

Description

protobi_get_table_details() returns details of all data tables associated with a Protobi project's schema (default) or primary-table.

Usage

protobi_get_table_details(
  projectid,
  apikey,
  scopekey = "schema",
  host = "https://v4.protobi.com",
  only_names = FALSE,
  prune = NULL
)

Arguments

projectid	A character. Protobi project identifier.
apikey	A character. The APIKEY from your account profile, https://app.protobi.com/account.
scopekey	A character. Defaults to "schema", can also be "primary". Gathers either all schema-table names or all primary-table names.
host	URL, defaults to "https://v4.protobi.com"
only_names	TRUE/FALSE, defaults to FALSE. Use TRUE to return only data table names. Optionally use 'prune' in tandem to filter result.
prune	Optional stringr-formatted pattern. Pattern match data table names to remove from result. only_names must be TRUE to use.

Value

An R data frame

protobi/protobi-r documentation built on July 8, 2023, 7:20 p.m.