FSK2R (version 0.1.3)

set_readme: Readme of an FSK object

Description

Readme of an FSK object

Usage

set_readme(fsk_object, readme_text)

Arguments

fsk_object

An instance of FSK2R.

readme_text

A character vector of length 1 with the content of the README file.

Value

An instance of FSK2R.

Examples

# NOT RUN {
 path_example <- system.file("extdata", "ToyModelv4.fskx", package = "FSK2R")
 my_fsk <- import_fsk(path_example)
 set_readme(my_fsk, "This is the README.")
# }
# NOT RUN {
# }