get_readme: Readme of an FSK object

View source: R/getters.R

get_readmeR Documentation

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)



FSK2R documentation built on March 18, 2022, 7:21 p.m.