get_cds_md: Get CDS metadata from cds_df tibbles.

Description Usage Arguments Value

View source: R/cds_df.R

Description

This function is a convienient getter function for accessing the attributes of cds_df objects which contain CDS metadata for the entity from which a cds_df was downloaded, as well as attributes and picklists. Use this function instead of base::attr() or base::attributes().

Usage

1
get_cds_md(cds_df, which_md = "entity")

Arguments

cds_df

A cds_df tibble, typically downloaded via cdsr::download_cds().

which_md

A character scalar indicating what kind of CDS metadata you would like to get from the cds_df. Must be one of the following: "entity", "attributes" or "picklists". The default is "entity".

Value

A tibble, or list of tibbles in case of "picklists", containing the requested CDS metadata information.


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