Learn R Programming

TKCat (version 1.1.12)

show_collection_def: Show the definition of a collection

Description

This function prints details regarding a collection: title, description and arguments information. These arguments are those that can be used to document collection members within an MDB using the add_collection_member() function.

Usage

show_collection_def(collection, silent = FALSE)

Value

A list with:

  • collection title

  • collection description

  • a list of arguments for defining collection members as a list of elements with:

    • the type of the argument element

    • allowed values if any

Arguments

collection

a json string with the collection definition as returned by get_local_collection()

silent

a logical indicating if the definition should be written (TRUE by default) or not.

Examples

Run this code
get_local_collection("BE") %>% show_collection_def()

Run the code above in your browser using DataLab