get_readme {FSK2R}

Readme of an FSK object

Description

Readme of an FSK object

Usage

get_readme(fsk_obj)

Arguments

fsk_obj

An object of class FSK2R

Value

A character vector with the text in the README file.

Examples

 path_example <- system.file("extdata", "ToyModelv4.fskx", package = "FSK2R")
 my_fsk <- import_fsk(path_example)
 get_readme(my_fsk)