get_slot_info: Retrieve slot details in rd-format

View source: R/docs.R

get_slot_infoR Documentation

Retrieve slot details in rd-format

Description

Retrieve slot details in rd-format

Usage

get_slot_info(class_name = "technology", slot_name = "ceff", col_names = TRUE)

Arguments

class_name

character, name of class.

slot_name

character, name of slot to retrieve.

col_names

logical, if columns information should be returned for data.frame slots.

Value

character, roxygen2 formatted string with slot details.

Examples

slotNames("technology")
get_slot_info("technology", "input") |> cat()
get_slot_info("technology", "capacity") |> cat()
get_slot_info("demand", "dem") |> cat()
get_slot_info("commodity", "agg") |> cat()

olugovoy/energyRt documentation built on Nov. 21, 2024, 2:24 a.m.