BGmisc

status
Project Status: Active – The project has reached a stable, usable state and is being actively developed. R package version Package downloads
R-CMD-check Dev Main branch codecov License

The BGmisc R package offers a comprehensive suite of functions tailored for extended behavior genetics analysis, including model identification, calculating relatedness, pedigree conversion, pedigree simulation, and more.

Installation

You can install the released version of BGmisc from CRAN with:

install.packages("BGmisc")

To install the development version of BGmisc from GitHub use:

# install.packages("devtools")
devtools::install_github("R-Computing-Lab/BGmisc")

Citation

If you use BGmisc in your research or wish to refer to it, please cite the following paper:

citation(package = "BGmisc")

Garrison, S. Mason, Hunter, Michael D., Lyu, Xuanyu, Trattner, Jonathan D., Burt, S. Alexandra (2024). “BGmisc: An R Package for Extended Behavior Genetics Analysis.” Journal of Open Source Software, 9(94). doi:10.21105/joss.06203 https://doi.org/10.21105/joss.06203.

A BibTeX entry for LaTeX users is

@Article{bgmisc,
  title = {BGmisc: An R Package for Extended Behavior Genetics Analysis},
  author = {{Garrison, S. Mason} and {Hunter, Michael D.} and {Lyu, Xuanyu} and {Trattner, Jonathan D.} and {Burt, S. Alexandra}},
  journal = {Journal of Open Source Software},
  year = {2024},
  volume = {9},
  number = {94},
  doi = {10.21105/joss.06203},
}

Contributing

Contributions to the BGmisc project are welcome. For guidelines on how to contribute, please refer to the Contributing Guidelines. Issues and pull requests should be submitted on the GitHub repository. For support, please use the GitHub issues page.

Branching and Versioning System

The development of BGmisc follows a GitFlow branching strategy:

License

BGmisc is licensed under the GNU General Public License v3.0. For more details, see the LICENSE.md file.