init_experiments {scifigure}R Documentation

Initialize a skeleton data frame to create a figure with sci_figure

Description

init_experiments generates a dataframe with the proper row and column headers for user manipulation before calling sci_figure

Usage

init_experiments(nexp = 3, exp_names = paste0("Exp", 1:nexp),
  stage_names = c("population", "question", "hypothesis",
  "experimental_design", "experimenter", "data", "analysis_plan",
  "analyst", "code", "estimate", "claim"))

Arguments

nexp

The number of scientific experiments to be represented in the data frame, i.e. number of columns.

exp_names

The names of each experiment, i.e. column names. Default: "Exp1, Exp2, ..."

stage_names

The names of each step in the process, i.e. row names. Defaults match Patil et. al.

See Also

sci_figure

Examples

# Generate the default data frame of three experiments
init_experiments()

init_experiments(nexp = 5,
exp_names = c("Run_16_01", "Run_16_04", "Run_16_07",
	"Run_16_09", "Run_16_12"))
testthat::expect_error({
init_experiments(nexp = 2, exp_names = names)
})

[Package scifigure version 0.2 Index]