runbayeSSC_with_conf: Run BayeSCC with a configuration table

Description Usage Arguments Value

View source: R/runbayeSSC_with_conf.R

Description

A wrapper function for running BayeSCC with a configuration table. See the example in the vignettes for requirements on the configuration table.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
runbayeSSC_with_conf(
  BayeSSCallocation,
  conf,
  prefix = "temp",
  species.assignment = NULL,
  exp.time = NULL,
  intern = TRUE,
  deletetempfolder = T,
  write.conf.to.file = F,
  write.obs.to.file = F
)

Arguments

BayeSSCallocation

A character string providing the path to the BayeSSC executable (including the file name itself)

conf

A data frame with configurations

prefix

A character string. BayeSSC will generate many intermediate files. This function will create temporary folders for storing these files. One folder for one row in the configuration table, and the folder will be named as prefix_row number.If folders with the same name already exist, user will be prompt for choosing another prefix or overwriting the folders.

species.assignment

A list showing species-to-event assignment. This can be NULL,if eventtime.generation is included as a column in the conf data frame.

exp.time

A numeric vector with the events time.This can be NULL,if eventtime.generation is included as a column in the conf data frame.

intern

TRUE(Default) or FALSE: the screen output of BayeSSC will be suppressed by default. If FALSE, all screen output of BayeSSC will be shown.

deletetempfolder

TRUE(Default) or FALSE, whether the temporary folders for holding BayeSCC's intermediate files will be deleted after running

write.conf.to.file

TRUE or FALSE(Default), whether to write the sampled configuration to a file. If TRUE, the file name will be prefix_conf_file

write.obs.to.file

TRUE or FALSE(Default), whether to write the observation data simulated by BayeSSC to a file. If TRUE, the file will be named prefix_obs_file

Value

A data frame storing the the observation summary statistics simulated BayeSSC


huatengh/CoExpansionValidation documentation built on Nov. 19, 2021, 11:07 a.m.