read_bcal {ArchaeoPhases}

R Documentation

Read MCMC output from BCal

Description

Import a CSV file containing the output of the MCMC algorithm produced by BCal.

Usage

read_bcal(file, bin_width = 1, quiet = "no")

Arguments

file	Either a path to a CSV file, a connection, or the value clipboard() to read from the system clipboard. The CSV file can be compressed or plain. See read_csv for details.
bin_width	The bin width specified for the BCal calibration. Defaults to the BCal default of 1.
quiet	One of "no" (default) to allow messages and warnings, "partial" to suppress messages and allow warnings, or "yes" to suppress messages and warnings.

Details

The read_bcal function is built on read_csv. It aims to be fast and simple, and to return the marginal posteriors free of extraneous artifacts. The iteration column in the CSV file is discarded, as are an empty last column and an empty last row.

Value

An archaeophases_mcmc object containing the marginal posterior(s) as a data frame, or NULL if file is not found.

Author(s)

Thomas S. Dye, tsd@tsdye.online

See Also

read_csv

ImportCSV

new_archaeophases_mcmc

Examples

## Not run: 
  # Import of MCMC output from BCal
  data(Fishpond)
  write.csv(Fishpond, "fishpond_MCMC.csv", row.names=FALSE)
  fishpond <- read_bcal("fishpond_MCMC.csv")

# Read from connection
  bc_1 <- read_bcal("http://tsdye.online/AP/bc-1.csv")
  bc_17 <- read_bcal("http://tsdye.online/AP/bc-17.csv", bin_width = 17)

## End(Not run)

---