R/vars_functions.R
vars_ssites.Rd
This function organizes higher-level information for creating variants from matrices of segregating sites output from coalescent simulations.
vars_ssites(obj = NULL, fn = NULL)
obj | Object containing segregating sites information.
This can be one of the following:
(1) A single |
---|---|
fn | A single string specifying the name of the file containing
the |
A vars_ssites_info
object containing information used in create_variants
to create haploid variants.
This class is just a wrapper around a list of matrices of segregating site info,
which you can view (but not change) using the object's mats()
method.
For what the seg_sites
field should look like in a list, see output from the
scrm
or coala
package.
(These packages are not required to be installed when installing
jackalope
.)
If using either of these packages, I encourage you to cite them. For citation
information, see output from citation("scrm")
or citation("coala")
.