updateDataset: Updates the parameters of an existing dataset (V2)

Description Usage Arguments Value

View source: R/updateDataset.R

Description

Uupdate an existing dataset in a Numetric Org.

This is useful when you want to add new columns to a dataset. You can also use it change the name or category of a dataset.

This function uses the V2 version of the API.

Usage

1
2
3
updateDataset(apiKey, datasetId, numetricName, dataframeName,
  category = "New Data", autocompletes = "", geoshapes = "",
  geopoints = "", boolean = "")

Arguments

apiKey

You can find the API key in the settings after logging into Numetric

datasetId

The dataset ID, in quotes, to be updated. It can be found by using the getDatasets function, or by navigating to the dataset in Numetric, and selecting the string after the last forward slash.

numetricName

The name, in quotes, given to the dataset in the Numetric Warehouse.

dataframeName

The name, without quotes, of the dataframe that will be used to create the dataset in Numetric.

category

The category, in quotes, given to the dataset in the Numetric Warehouse.

autocompletes

The column name, or vector of column names, in quotes, that will autocomplete in the Numetric quick search bar.

geoshapes

The column name, or vector of column names, in quotes, that will be stored as a geoShape (point on a map). This needs to be in the format, "lat,long".

geopoints

The column name, or vector of column names, in quotes, that will be stored as a geoPoint (for heatmaps). This needs to be in the format, "lat,long".

boolean

The column name, or vector of column names, in quotes, that will be stored as True/False. True = 1, False = 0.

id

The name of the column, in quotes, that will be used as the primary key. Each row should have a unique id, otherwise, the last row indexed will be the one saved.

Value

Returns the status of the update.


RonGuymon/numetricAPI documentation built on May 6, 2019, 10:12 a.m.