download_cds: Download data from CDS as a formatted tibble with metadata.

In jarekkupisz/cdsR: R Interface to Microsoft's Dataverse (formerly Common Data Service - CDS)

Description

This is the main function of the package which allows for easy downloading of data from CDS into your R session. It provides the CDS metadata via attributes "md_ent" and "md_attributes" as tibbles as well, so you can benefit from it when automatizing the analytics tasks.

Usage

download_cds(
  query,
  cds_instance_name = NULL,
  select = NULL,
  filter = NULL,
  order_by = NULL,
  top = NULL
)

Arguments

query	A character scalar with the odata request for which you wish to download a result. Typically it will be a plural logical name of an entity ("contacts", "accounts", "phonecalls", etc.). It is passed directly in a request so complex queries with odata operators are possible. The only condition is that it has to perform a retrieve operation on a main entity.
cds_instance_name	A character scalar used in initialize_cds_token() to name a CDS instance. Default NULL. If only one cds_token object is present in getOption("cdsR.tokens"), then you do not need to specify this argument.
select	A string or vector of strings with names of attributes you wish to select from an entity. If a vector, all values will be collapsed using "," as separator.
filter	A string or vector of strings with odata filter statements. If vector, all values will be collapsed using " and " simmilarly to dplyr's filter.
order_by	A string or vector of strings expressing entity fields by which you wish to arrange the result. If a vector, all values will be collapsed using "," as separator.
top	A scalar integer determining how many rows of the base entity you wish to retrieve.

Details

Tibbles returned by this function have several properties

• All enum type fields (picklists, status and state) are returned as proper character vectors containing labels, not the integer keys that the Web API normally returns.

• In "md_ent" attribute (attr(a_cds_df, "md_ent")) you can find all entity metadata listed here.

• In "md_attributes" attribute (attr(a_cds_df, "md_attributes")) you can find all details regarding returned entitiy's attributes. The full list can be found here.

• In "md_enums_dicts" attribute (attr(a_cds_df, "md_enums_dicts")) you can find list of tibbles representing key, value pairs for enums fields which were used to parse them

Value

A cds_df S3 object, which is essentially a tibble with additional attributes described in the Details section.

jarekkupisz/cdsR documentation built on Dec. 20, 2021, 9:05 p.m.