UploadTableToFactbase: Upload a table of raw data to Factbase.

View source: R/Factbase.R

UploadTableToFactbaseR Documentation

Upload a table of raw data to Factbase.

Description

Upload a table of raw data to Factbase.

Usage

UploadTableToFactbase(
  table_name,
  data,
  token,
  mode = "replace_all",
  definition = NULL,
  hyperlink = NULL,
  owner = NULL,
  na_columns = NULL,
  unique_columns = NULL,
  test = list()
)

Arguments

table_name

The name to use to refer to this data in Factbase.

data

A data.frame containing columns of data. Character, factor (converted to character), numeric, boolean (converted to character) and date/time ('Date' or 'POSIXt') columns are acceptable.

token

A guid that identifies and authenticates the request. Talk to Oliver if you need one of these.

mode

(optional) One of "replace_all", "append" or "append_or_update" See comments for FactPostUpdateType.

definition

A detailed explanation of the meaning and derivation of the data.

hyperlink

A link to a web page where more can be read about the data. Preferably this is a link into the system that calls this function.

owner

The name (usually an email address) of whoever should be contacted to deal with problems or questions about this data.

na_columns

(optional) If set then this should be a character vector naming the columns that may contain NAs, which will be converted into nulls int the resultant table.

unique_columns

(optional) If set then this should be a character vector naming the columns that will contain values that are all unique. This allows you to use other values than 'update_all' for 'mode'.

test

(optional) For testing only. Ignore.

Value

The value of 'data' that was passed in, so caller can see data uploaded if this is the last call in R code.


Displayr/flipAPI documentation built on April 17, 2024, 9:42 a.m.