README.md
In gscramble: Simulating Admixed Genotypes Without Replacement

gscramble

This is an R package for simulating individuals that are admixed between different populations according to a pedigree. To do so it uses sampling without replacement from samples taken from each population.

You can read the documentation for it at: https://eriqande.github.io/gscramble/

You can install in from GitHub:

remotes::install_github(
  "eriqande/gscramble", 
  build_opts = c("--no-resave-data"), 
  build_vignettes = TRUE, 
  build_manual = TRUE,
  quiet = FALSE
)

Once that is installed you can read the vignettes:

vignette("gscramble-tutorial")  # information on input data objects
vignette("about-createGSP")  # a function to make simple genomic simulation pedigrees
vignette("permutation-options")  # about the different options for permuting