register_udf: Register a UDF on TileDB Cloud
In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

register_udf

R Documentation

Register a UDF on TileDB Cloud

Description

Registers a user-defined function on TileDB Cloud, so that it may be invoked by name later.

Usage

register_udf(
  namespace = NULL,
  name,
  type,
  func,
  func_text = NULL,
  version = NULL,
  image_name = NULL,
  readme = NULL,
  license_id = NULL,
  license_text = NULL,
  tags = NULL
)

Arguments

`namespace`	Namespace for the UDF to be stored in, e.g. `mynamespace`. If omitted, defaults to username.
`name`	character Name for the function to be stored under in TileDB Cloud, e.g. `myudfname`.
`type`	character One of `generic`, `single_array`, or `multi_array`.
`func`	An R function which takes a dataframe as first argument.
`version`	character Optional version string.
`image_name`	character
`readme`	README text to be displayed in the TileDB Cloud UI.
`license_id`	character See the TileDB Cloud UI for options.
`license_text`	character See the TileDB Cloud UI for options.
`tags`	list(character) Tags to apply to the UDF.
`exec_raw`	character Text to display in the TileDB Cloud UI's Preview tab. If omitted, a full deparse of `func` is used. You can set this to something shorter for brevity if you like.

Value

No return value.

Other manual-layer functions: array_info(), compute_sequentially(), compute(), delayed_args<-(), delayed_args(), delayed_array_udf(), delayed_generic_udf(), delayed_sql(), delayed(), deregister_array(), deregister_group(), deregister_udf(), execute_array_udf(), execute_generic_udf(), execute_multi_array_udf(), execute_sql_query(), get_udf_info(), group_info(), list_arrays(), list_groups(), login(), register_array(), update_udf_info(), user_profile()