UpdateFactbasePenetrationFormula: Creates or updates a metric described by a formula over other...

In NumbersInternational/flipAPI: Web APIs tools

Creates or updates a metric described by a formula over other metrics. See https://factbase.azurewebsites.net/static/pages/help.html#penetration

Description

Creates or updates a metric described by a formula over other metrics. See https://factbase.azurewebsites.net/static/pages/help.html#penetration

Usage

UpdateFactbasePenetrationFormula(
  metric_name,
  token,
  numerator,
  denominator,
  dimensions_to_count,
  definition,
  hyperlink,
  owner,
  as_percentage = F,
  test = list()
)

Arguments

metric_name	The name that will appear for selection by Factbase users.
token	A Personal Access Token generated in Factbase at Add data > personal access tokens.
numerator	The name of an existing metric. See the documentation reference above.
denominator	The name of an existing metric. See the documentation reference above.
dimensions_to_count	A character vector of label dimension names. See the documentation reference above.
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.
as_percentage	If set to TRUE then when shown this formula's values will be multiplied by 100 and given a percent sign.
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.

NumbersInternational/flipAPI documentation built on July 23, 2024, 8:09 a.m.