FSK2R (version 0.2.0)

get_readme: Readme of an FSK object

Description

Readme of an FSK object

Usage

get_readme(fsk_obj)

Value

A character vector with the text in the README file.

Arguments

fsk_obj

An object of class FSK2R

Examples

# \donttest{
 path_example <- system.file("extdata", "ToyModelv4.fskx", package = "FSK2R")
 my_fsk <- import_fsk(path_example)
 get_readme(my_fsk)
# }