create_fsk: Creates an FSK model from an existing R script

In FSK2R: An Interface Between the 'FSKX' Standard and 'R'

Creates an FSK model from an existing R script

Description

The model includes the R model. If provided as arguments, it also includes the visualization script and the README. Besides, it generates a typical model_metadata, as well as a simulation (without parameters). The manifest is left empty.

Usage

create_fsk(
  r_model,
  r_visualization = NULL,
  readme = NULL,
  other_files = NULL,
  pckg_frame = NULL
)

Arguments

r_model	character with the path to the R script with the model.
r_visualization	(optional) character with the path to the R script with the visualization.
readme	(optional) path to README file.
other_files	(optional) character vector with the path to additional
pckg_frame	(optional) data.frame with 2 columns 'Package' files required by the model.

Value

An instance of FSK2R.

Examples

 model_path <- system.file("extdata", "model.r", package = "FSK2R")
 visualization_path <- system.file("extdata", "visualization.r", package = "FSK2R")
 FSK_from_R <- create_fsk(model_path, visualization_path)

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