FactbaseUploadWidget: This function is for Displayr internal use only.

In NumbersInternational/flipAPI: Web APIs tools

This function is for Displayr internal use only.

Description

The R code for the standard R item *Upload to Factbase*, which provides a zero code way to upload a metric using the Factbase R API.

Usage

FactbaseUploadWidget(
  factbase.token = "",
  mode = "Replace all",
  aggregation = "None",
  time_aggregation = NULL,
  period_type = NULL,
  definition = NULL,
  hyperlink = NULL,
  owner = NULL,
  do.upload = TRUE,
  selection.type = "Table",
  input.table = NULL,
  make.dummy.metric = NULL,
  metric.variables = NULL,
  metric.column.names = "",
  date.column.name = "",
  date.variable = NULL,
  dimension.column.names = "",
  dimension.variables = NULL,
  output.type = "Data Summaries",
  start.date = "",
  time.zone = "Australia/Sydney",
  update.period = "days",
  update.frequency = 1,
  us.format = FALSE
)

Arguments

factbase.token	Undocumented
mode	Undocumented
aggregation	Undocumented
time_aggregation	Undocumented
period_type	Undocumented
definition	Undocumented
hyperlink	Undocumented
owner	Undocumented
do.upload	Undocumented
selection.type	Undocumented
input.table	Undocumented
make.dummy.metric	Undocumented
metric.variables	Undocumented
metric.column.names	Undocumented
date.column.name	Undocumented
date.variable	Undocumented
dimension.column.names	Undocumented
dimension.variables	Undocumented
output.type	Undocumented
start.date	Undocumented
time.zone	Undocumented
update.period	Undocumented
update.frequency	Undocumented
us.format	Undocumented

Details

Parameters come out of the R UI JavaScript code in https://github.com/Displayr/factbase/blob/master/displayr/Upload See that code to understand the meaning of those controls.

We would prefer not to export this function, but not doing so causes build failures. We cannot move the function into flipFormat because it calls functions in flipAPI that would trigger circular import dependencies because flipAPI depends on flipFormat.

Value

An HTMLwidget that shows summary details about the upload.

NumbersInternational/flipAPI documentation built on May 8, 2024, 5:14 a.m.