Skip to contents

Dictionary of layers

Source: R/def_DocumentationDesc.R
get_layer_dict.Rd

Function for receiving a list containing a description of all layers user of the package can apply.

Usage

get_layer_dict(layer)

Arguments

layer

string Name of the layer that should be returned. If layer="all" all layers are returned as a list.

Value

Returns a list with the following entries:

  • title: string Name of the layer.

  • desc: stringDescription of the layer written in rmarkdown.

  • img: string Name of the image used to illustrate the layer. File extension must be '.png'.

  • references: vector of strings. Every entry contains the literature reference in rmarkdown if relevant.

  • param_prefix: string Prefix used for all parameters to configure the specific layer.

See also

Other Utils Documentation: build_documentation_for_model(), build_layer_stack_documentation_for_vignette(), get_desc_for_core_model_architecture(), get_dict_cls_type(), get_dict_core_models(), get_dict_input_types(), get_layer_documentation(), get_parameter_documentation()