{
  "_id": "6a107ad4acfb0bcc41cadc9b",
  "Package": "simfam",
  "Title": "Simulate and Model Family Pedigrees with Structured Founders",
  "Version": "1.1.16.9000",
  "Authors@R": "person(given = \"Alejandro\",\nfamily = \"Ochoa\",\nrole = c(\"aut\", \"cre\"),\nemail = \"alejandro.ochoa@duke.edu\",\ncomment = c(ORCID = \"0000-0003-4928-3403\"))",
  "Description": "The focus is on simulating and modeling families with\nfounders drawn from a structured population (for example, with\ndifferent ancestries or other potentially non-family\nrelatedness), in contrast to traditional pedigree analysis that\ntreats all founders as equally unrelated.  Main function\nsimulates a random pedigree for many generations, avoiding\nclose relatives, pairing closest individuals according to a 1D\ngeography and their randomly-drawn sex, and with variable\nchildren sizes to result in a target population size per\ngeneration.  Auxiliary functions calculate kinship matrices,\nadmixture matrices, and draw random genotypes across arbitrary\npedigree structures starting from the corresponding founder\nvalues.  The code is built around the plink FAM table format\nfor pedigrees.  There are functions that simulate independent\nloci and also functions that use an explicit recombination\nmodel to simulate linkage disequilibrium (LD) in the pedigree,\nas well as population analogs resembling the Li-Stephens model.\nDescribed in Yao and Ochoa (2023) <doi:10.7554/eLife.79238>.",
  "License": "GPL (>= 3)",
  "Encoding": "UTF-8",
  "Roxygen": "list(markdown = TRUE)",
  "RoxygenNote": "7.3.2",
  "Config/testthat/edition": "3",
  "VignetteBuilder": "knitr",
  "URL": "https://github.com/OchoaLab/simfam",
  "BugReports": "https://github.com/OchoaLab/simfam/issues",
  "LazyData": "true",
  "Repository": "https://ochoalab.r-universe.dev",
  "Date/Publication": "2025-01-08 18:08:26 UTC",
  "RemoteUrl": "https://github.com/ochoalab/simfam",
  "RemoteRef": "HEAD",
  "RemoteSha": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
  "NeedsCompilation": "yes",
  "Packaged": {
    "Date": "2026-05-06 07:57:27 UTC",
    "User": "root"
  },
  "Author": "Alejandro Ochoa [aut, cre] (ORCID:\n<https://orcid.org/0000-0003-4928-3403>)",
  "Maintainer": "Alejandro Ochoa <alejandro.ochoa@duke.edu>",
  "MD5sum": "5b353000997f0918b89c1f9c9551836b",
  "_user": "ochoalab",
  "_type": "src",
  "_file": "simfam_1.1.16.9000.tar.gz",
  "_fileid": "432061dacfa30a53732b79e3177795c2e90423facf9c6f51131ef2f182336f57",
  "_filesize": 3368966,
  "_sha256": "432061dacfa30a53732b79e3177795c2e90423facf9c6f51131ef2f182336f57",
  "_created": "2026-05-06T07:57:27.000Z",
  "_published": "2026-05-22T15:48:36.251Z",
  "_distro": "noble",
  "_jobs": [
    {
      "job": 77414136367,
      "time": 154,
      "config": "linux-devel-arm64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "6825321815"
    },
    {
      "job": 77414136281,
      "time": 167,
      "config": "linux-devel-x86_64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "6825325118"
    },
    {
      "job": 77414136173,
      "time": 149,
      "config": "linux-release-arm64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6825320665"
    },
    {
      "job": 77414136287,
      "time": 156,
      "config": "linux-release-x86_64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6825322063"
    },
    {
      "job": 77414136376,
      "time": 106,
      "config": "macos-oldrel-arm64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6825310308"
    },
    {
      "job": 77414136168,
      "time": 234,
      "config": "macos-oldrel-x86_64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6825342220"
    },
    {
      "job": 77414136250,
      "time": 121,
      "config": "macos-release-arm64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6825313983"
    },
    {
      "job": 77414136146,
      "time": 250,
      "config": "macos-release-x86_64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6825346425"
    },
    {
      "job": 77414135793,
      "time": 243,
      "config": "source",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6825281730"
    },
    {
      "job": 77414135609,
      "time": 125,
      "config": "wasm-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7164670263"
    },
    {
      "job": 77414136328,
      "time": 171,
      "config": "windows-devel",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "6825325846"
    },
    {
      "job": 77414136562,
      "time": 140,
      "config": "windows-oldrel",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6825318338"
    },
    {
      "job": 77414136450,
      "time": 128,
      "config": "windows-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6825315472"
    }
  ],
  "_buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119",
  "_status": "success",
  "_host": "GitHub-Actions",
  "_upstream": "https://github.com/ochoalab/simfam",
  "_commit": {
    "id": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
    "author": "Alejandro Ochoa Garcia <alexviiiag@gmail.com>",
    "committer": "Alejandro Ochoa Garcia <alexviiiag@gmail.com>",
    "message": "Function `sim_pedigree` optimized for sparse case: internal C++ code now identifies all close relatives in a single scan of the sparse structure\n",
    "time": 1736359706
  },
  "_maintainer": {
    "name": "Alejandro Ochoa",
    "email": "alejandro.ochoa@duke.edu",
    "login": "alexviiia",
    "orcid": "0000-0003-4928-3403",
    "uuid": 12603341
  },
  "_registered": true,
  "_dependencies": [
    {
      "package": "R",
      "version": ">= 2.10",
      "role": "Depends"
    },
    {
      "package": "Rcpp",
      "role": "LinkingTo"
    },
    {
      "package": "Rcpp",
      "role": "Imports"
    },
    {
      "package": "stats",
      "role": "Imports"
    },
    {
      "package": "tibble",
      "role": "Imports"
    },
    {
      "package": "dplyr",
      "role": "Imports"
    },
    {
      "package": "tidyselect",
      "role": "Imports"
    },
    {
      "package": "rlang",
      "role": "Imports"
    },
    {
      "package": "Matrix",
      "role": "Imports"
    },
    {
      "package": "methods",
      "role": "Imports"
    },
    {
      "package": "testthat",
      "version": ">= 3.0.0",
      "role": "Suggests"
    },
    {
      "package": "popkin",
      "role": "Suggests"
    },
    {
      "package": "bnpsd",
      "version": ">= 1.3.2",
      "role": "Suggests"
    },
    {
      "package": "genio",
      "role": "Suggests"
    },
    {
      "package": "BEDMatrix",
      "role": "Suggests"
    },
    {
      "package": "kinship2",
      "role": "Suggests"
    },
    {
      "package": "RColorBrewer",
      "role": "Suggests"
    },
    {
      "package": "knitr",
      "role": "Suggests"
    },
    {
      "package": "rmarkdown",
      "role": "Suggests"
    }
  ],
  "_owner": "ochoalab",
  "_selfowned": true,
  "_usedby": 0,
  "_updates": [],
  "_tags": [],
  "_stars": 3,
  "_contributors": [
    {
      "user": "alexviiia",
      "count": 40,
      "uuid": 12603341
    }
  ],
  "_userbio": {
    "uuid": 41968176,
    "type": "organization",
    "name": "Ochoa Lab at Duke StatGen",
    "description": "Research in statgen, biostats, compbio"
  },
  "_downloads": {
    "count": 220,
    "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/simfam"
  },
  "_devurl": "https://github.com/ochoalab/simfam",
  "_searchresults": 18,
  "_topics": [
    "cpp"
  ],
  "_rbuild": "4.6.0",
  "_assets": [
    "extra/citation.cff",
    "extra/citation.html",
    "extra/citation.json",
    "extra/citation.txt",
    "extra/contents.json",
    "extra/NEWS.html",
    "extra/NEWS.txt",
    "extra/readme.html",
    "extra/readme.md",
    "extra/simfam.html",
    "manual.pdf"
  ],
  "_homeurl": "https://github.com/ochoalab/simfam",
  "_realowner": "ochoalab",
  "_cranurl": true,
  "_releases": [
    {
      "version": "1.0.2",
      "date": "2021-09-02"
    },
    {
      "version": "1.0.3",
      "date": "2021-10-06"
    },
    {
      "version": "1.1.6",
      "date": "2023-01-14"
    }
  ],
  "_exports": [
    "admix_fam",
    "admix_last_gen",
    "bim_add_posg",
    "draw_sex",
    "fam_ancestors",
    "geno_fam",
    "geno_last_gen",
    "geno_last_gen_admix_recomb",
    "indexes_chr",
    "kinship_fam",
    "kinship_last_gen",
    "pop_recomb",
    "prune_fam",
    "recomb_admix_inds",
    "recomb_fam",
    "recomb_founder_blocks_inherited",
    "recomb_geno_inds",
    "recomb_haplo_inds",
    "recomb_init_founders",
    "recomb_last_gen",
    "recomb_map_fix_ends_chr",
    "recomb_map_inds",
    "recomb_map_simplify_chr",
    "sim_pedigree",
    "tidy_recomb_map_inds"
  ],
  "_datasets": [
    {
      "name": "recomb_map_hg37",
      "title": "Simplified recombination maps for human genomes",
      "object": "recomb_map_hg37",
      "class": [
        "list"
      ],
      "fields": [],
      "table": true,
      "tojson": true
    },
    {
      "name": "recomb_map_hg38",
      "title": "Simplified recombination maps for human genomes",
      "object": "recomb_map_hg38",
      "class": [
        "list"
      ],
      "fields": [],
      "table": true,
      "tojson": true
    }
  ],
  "_help": [
    {
      "page": "admix_fam",
      "title": "Calculate admixture matrix of a pedigree with known admixture of founders",
      "topics": [
        "admix_fam"
      ]
    },
    {
      "page": "admix_last_gen",
      "title": "Calculate admixture matrix for last generation of a pedigree with admixture of founders",
      "topics": [
        "admix_last_gen"
      ]
    },
    {
      "page": "bim_add_posg",
      "title": "Calculate genetic positions from base pair positions and a genetic map",
      "topics": [
        "bim_add_posg"
      ]
    },
    {
      "page": "draw_sex",
      "title": "Draw sex values randomly for a list of individuals",
      "topics": [
        "draw_sex"
      ]
    },
    {
      "page": "fam_ancestors",
      "title": "Construct an ancestors-only pedigree for one person 'G'-generations deep",
      "topics": [
        "fam_ancestors"
      ]
    },
    {
      "page": "geno_fam",
      "title": "Draw random genotypes on a pedigree with known founder genotypes",
      "topics": [
        "geno_fam"
      ]
    },
    {
      "page": "geno_last_gen",
      "title": "Draw random genotypes for last generation of a pedigree with known founder genotypes",
      "topics": [
        "geno_last_gen"
      ]
    },
    {
      "page": "geno_last_gen_admix_recomb",
      "title": "Simulate an admixed family efficiently with founders with LD",
      "topics": [
        "geno_last_gen_admix_recomb"
      ]
    },
    {
      "page": "indexes_chr",
      "title": "Extract last index of every chromosome in a vector of chromosomes",
      "topics": [
        "indexes_chr"
      ]
    },
    {
      "page": "kinship_fam",
      "title": "Calculate kinship matrix of a pedigree with structured founders",
      "topics": [
        "kinship_fam"
      ]
    },
    {
      "page": "kinship_last_gen",
      "title": "Calculate kinship matrix for last generation of a pedigree with structured founders",
      "topics": [
        "kinship_last_gen"
      ]
    },
    {
      "page": "pop_recomb",
      "title": "Simulate genotypes with linkage disequilibrium (LD) given a population of haplotypes, using a Li-Stephens-like model of haplotype copying",
      "topics": [
        "pop_recomb"
      ]
    },
    {
      "page": "prune_fam",
      "title": "Remove non-ancestors of a set of individuals from pedigree",
      "topics": [
        "prune_fam"
      ]
    },
    {
      "page": "recomb_admix_inds",
      "title": "Reduce haplotype ancestry data to population ancestry dosage matrices",
      "topics": [
        "recomb_admix_inds"
      ]
    },
    {
      "page": "recomb_fam",
      "title": "Draw recombination breaks for autosomes from a pedigree",
      "topics": [
        "recomb_fam"
      ]
    },
    {
      "page": "recomb_founder_blocks_inherited",
      "title": "Identify IBD blocks of founders that were inherited by at least one individual in this data",
      "topics": [
        "recomb_founder_blocks_inherited"
      ]
    },
    {
      "page": "recomb_geno_inds",
      "title": "Reduce haplotype data to genotype matrix",
      "topics": [
        "recomb_geno_inds"
      ]
    },
    {
      "page": "recomb_haplo_inds",
      "title": "Construct haplotypes of individuals given their ancestral blocks and the ancestral haplotype variants",
      "topics": [
        "recomb_haplo_inds"
      ]
    },
    {
      "page": "recomb_init_founders",
      "title": "Initialize chromosome structures for founders",
      "topics": [
        "recomb_init_founders"
      ]
    },
    {
      "page": "recomb_last_gen",
      "title": "Draw recombination breaks for autosomes for last generation of a pedigree",
      "topics": [
        "recomb_last_gen"
      ]
    },
    {
      "page": "recomb_map_fix_ends_chr",
      "title": "Extrapolate and shift recombination map of one chromosome to ends",
      "topics": [
        "recomb_map_fix_ends_chr"
      ]
    },
    {
      "page": "recomb_map_hg",
      "title": "Simplified recombination maps for human genomes",
      "topics": [
        "recomb_map_hg",
        "recomb_map_hg37",
        "recomb_map_hg38"
      ]
    },
    {
      "page": "recomb_map_inds",
      "title": "Map recombination breaks from genetic positions to base pair coordinates",
      "topics": [
        "recomb_map_inds"
      ]
    },
    {
      "page": "recomb_map_simplify_chr",
      "title": "Simplify recombination map of one chromosome to a desired numerical precision",
      "topics": [
        "recomb_map_simplify_chr"
      ]
    },
    {
      "page": "sim_pedigree",
      "title": "Construct a random pedigree",
      "topics": [
        "sim_pedigree"
      ]
    },
    {
      "page": "tidy_recomb_map_inds",
      "title": "Tidy recombination block data inherited in individuals from founders",
      "topics": [
        "tidy_recomb_map_inds"
      ]
    }
  ],
  "_pkglogo": "https://github.com/ochoalab/simfam/raw/HEAD/man/figures/logo.png",
  "_readme": "https://github.com/ochoalab/simfam/raw/HEAD/README.md",
  "_rundeps": [
    "cli",
    "dplyr",
    "generics",
    "glue",
    "lattice",
    "lifecycle",
    "magrittr",
    "Matrix",
    "pillar",
    "pkgconfig",
    "R6",
    "Rcpp",
    "rlang",
    "tibble",
    "tidyselect",
    "utf8",
    "vctrs",
    "withr"
  ],
  "_sysdeps": [
    {
      "shlib": "libstdc++",
      "package": "libstdc++6",
      "source": "gcc",
      "version": "14.2.0-4ubuntu2~24.04.1",
      "name": "c++",
      "homepage": "http://gcc.gnu.org/",
      "description": "GNU Standard C++ Library v3"
    }
  ],
  "_vignettes": [
    {
      "source": "simfam.Rmd",
      "filename": "simfam.html",
      "title": "simfam: simulate and model family pedigrees with structured founders",
      "author": "Alejandro Ochoa",
      "engine": "knitr::rmarkdown",
      "headings": [
        "Introduction",
        "Small example",
        "Construct random pedigree",
        "Visualizing the pedigree",
        "Pruning individuals without descendants",
        "Drawing genotype data: unstructured founders",
        "Drawing genotype data: admixed founders",
        "Admixture proportions in the pedigree",
        "Total kinship partitioned into structural and family components",
        "Large example",
        "Example with recombination"
      ],
      "created": "2021-08-04 21:14:46",
      "modified": "2022-06-27 02:48:15",
      "commits": 11
    }
  ],
  "_score": 4.431363764158987,
  "_indexed": true,
  "_nocasepkg": "simfam",
  "_universes": [
    "ochoalab",
    "alexviiia"
  ],
  "_binaries": [
    {
      "r": "4.7.0",
      "os": "linux",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:59:50.000Z",
      "distro": "noble",
      "arch": "aarch64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "7d86ae7213e57cd7e36ddb0a5b9b92b0d4208bdd06582d8318e910ba1e89cf6d",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.7.0",
      "os": "linux",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:59:58.000Z",
      "distro": "noble",
      "arch": "x86_64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "5738c80806184d0e56d6437aa7085c7c0c59398c2b7201f1536c5b28e700e9cc",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.6.0",
      "os": "linux",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:59:46.000Z",
      "distro": "noble",
      "arch": "aarch64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "76e6a39f4046e132310c7d94ecec2f4651c479d58b54f297ac6634e2f54a9337",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.6.0",
      "os": "linux",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:59:50.000Z",
      "distro": "noble",
      "arch": "x86_64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "09532879caf664af6b87d583ae940143aaefb30b6e938b8d8840ef9dd5924a62",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:59:13.000Z",
      "arch": "aarch64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "c2f7e9af74d84b6969c3d30a3af5db3689b9012c0da002777a9d8e78c99bca73",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "1.1.16.9000",
      "date": "2026-05-06T08:00:41.000Z",
      "arch": "x86_64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "11acb9f22efb90b8a5d46b8a5fb7dd29b561355cd5c89c8dfe2bd76851dd09a7",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.6.0",
      "os": "mac",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:59:20.000Z",
      "arch": "aarch64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "a9c0a10416fa420738c032a2a555734c98dd85f6098bdb7874391af6209d1644",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.6.0",
      "os": "mac",
      "version": "1.1.16.9000",
      "date": "2026-05-06T08:00:53.000Z",
      "arch": "x86_64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "bc8fd073e102a2a027723126bd21b683442b184710eac3c74dcf30900d910c2c",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.7.0",
      "os": "win",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:59:21.000Z",
      "arch": "x86_64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "3bf00ba3cf8b053cf8d57edb5683a9d8672e49ba79130afa9ca44d8c7e7814ac",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.5.3",
      "os": "win",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:58:59.000Z",
      "arch": "x86_64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "1ace552288db47decc2483a83800771242c723c2201151e08167139f3b7937bd",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.6.0",
      "os": "win",
      "version": "1.1.16.9000",
      "date": "2026-05-06T07:58:50.000Z",
      "arch": "x86_64",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "e43a60051187363589317cca8972bd848497e89bfe7a8cab4018e00eef629342",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    },
    {
      "r": "4.6.0",
      "os": "wasm",
      "version": "1.1.16.9000",
      "date": "2026-05-22T15:48:00.000Z",
      "arch": "emscripten",
      "commit": "5cd929803cd0ceaf68e3bcfc2f7a3c63a4a33e24",
      "fileid": "5e1aa8e7b474785b96e9e023accd210a4b207a477bc0e0c6c2ba29f0cfe5d6b2",
      "status": "success",
      "buildurl": "https://github.com/r-universe/ochoalab/actions/runs/25423175119"
    }
  ]
}