write_gsi_sim_reference: Write a reference data frame to gsi_sim format baseline and...

View source: R/write_gsi_sim_reference.R

write_gsi_sim_referenceR Documentation

Write a reference data frame to gsi_sim format baseline and repunits file

Description

Note, this is only intended to work with integer-valued alleles, at the moment. It was just written for testing and verifying that things are working correctly.

Usage

write_gsi_sim_reference(
  ref,
  gen_start_col,
  baseout = "baseline.txt",
  repout = "repunits.txt"
)

Arguments

ref

reference data frame

gen_start_col

column in which the genetic data start

baseout

path to write the baseline file to. Required.

repout

path to write the repunits file to. Required.

Examples

# create a temp directory to put example outputs
dd <- tempdir()
basefile <- file.path(dd, "baseline.txt")
repunitsfile <- file.path(dd, "repunits.txt")

# print those
basefile
repunitsfile

# note that in practice you will probably want to specify
# your own filepaths...

# run the function
write_gsi_sim_reference(alewife, 17, basefile, repunitsfile)

benmoran11/rubias documentation built on Feb. 1, 2024, 10:52 p.m.