create_replication: Create replication object
In gerasy1987/replication: Replication Package

Description Usage Arguments Value Examples

View source: R/create_replication.R

The function takes main parts of replication object as an arguments and returns the replication class object.

1
2
3

create_replication(description_list, packages = NULL, project_path = NULL,
  data_list, function_script_path, replication_script_path, quietly = FALSE,
  checks = TRUE)

`description_list`	List of miscellaneous descriptions of replication.
`packages`	Character vector of packages required for replication.
`project_path`	Character string giving the path to the directory, where function and replication scripts are stored. Defaults to `NULL`, which is reasonable if RStudio project is used.
`data_list`	A named list of data-frames used for the replication.
`function_script_path`	Character string giving the name of `R` script which contains all functions required for the replication. The script should only include declarations of named functions using `<-` operator.
`replication_script_path`	Character string giving the name of `R` script which contains all calls for table replications. The script should consist of only single calls for replication of one table and the table objects should be created using `<-` operator.
`quietly`	Logical. Whether the creation of replication should go without any messages printed to console.
`checks`	Logical. If `quietly = FALSE`, whether the checks for packages and consistency of replication should be performed.