read_gcae_experiment_params_file: Read a 'gcae_experiment_params' from file

In richelbilderbeek/gcaer: Interface to GCAE

Read a gcae_experiment_params from file

Description

Read a gcae_experiment_params from file

Usage

read_gcae_experiment_params_file(gcae_experiment_params_filename)

Arguments

gcae_experiment_params_filename

name of the file to save/read gcae_experiment_params to/from, using read_gcae_experiment_params_file and save_gcae_experiment_params

Value

the gcae_experiment_params as can be checked by check_gcae_experiment_params

Note

it is possible to add character values to the gcae_experiment_params, for example:

gcae_experiment_params <- create_test_gcae_experiment_params()
gcae_experiment_params$window_kb <- "1000"

read_gcae_experiment_params_file will always read these extra values as a character.

Author(s)

Richèl J.C. Bilderbeek

See Also

use save_gcae_experiment_params to save a gcae_experiment_params

Examples

# Create a gcae_experiment_params
gcae_experiment_params <- create_test_gcae_experiment_params()

# Use a temporary file
gcae_experiment_params_filename <- get_gcaer_tempfilename(fileext = ".csv")

# Save gcae_experiment_params to temporary file
save_gcae_experiment_params(
  gcae_experiment_params = gcae_experiment_params,
  gcae_experiment_params_filename = gcae_experiment_params_filename
)

# Load the temporary file to get a copy of the gcae_experiment_params
gcae_experiment_params_again <- read_gcae_experiment_params_file(
  gcae_experiment_params_filename
)

# Cleanup
file.remove(gcae_experiment_params_filename)

richelbilderbeek/gcaer documentation built on March 25, 2024, 3:08 p.m.