remove_burn_in: Removed the burn-in from a trace

Description Usage Arguments Value Author(s) Examples

Description

Removed the burn-in from a trace

Usage

1
remove_burn_in(trace, burn_in_fraction)

Arguments

trace

the values

burn_in_fraction

the fraction that needs to be removed, must be [0,1>

Value

the values with the burn-in removed

Author(s)

Richel J.C. Bilderbeek

Examples

1
2
3
4
5
6
7
8
9
  # Create a trace from one to and including ten
  v <- seq(1, 10)

  # Remove the first ten percent of its values,
  # in this case removes the first value, which is one
  w <- remove_burn_in(trace = v, burn_in_fraction = 0.1)

  # Check that the result goes from two to ten
  testit::assert(w == seq(2, 10))

beast-dev/RBeast documentation built on May 12, 2019, 10:02 a.m.