Repository files navigation

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

You can install the released version of BGmisc fromCRAN with:

install.packages("BGmisc")

To install the development version of BGmisc fromGitHub use:

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

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

citation(package = "BGmisc")

Garrison, S. Mason, Hunter, Michael D., Lyu, Xuanyu, Trattner, JonathanD., Burt, S. Alexandra (2024). “BGmisc: An R Package for ExtendedBehavior Genetics Analysis.”Journal of Open Source Software,9(94).doi:10.21105/joss.06203https://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},}

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

The development of BGmisc follows aGitFlow branchingstrategy:

• Feature Branches: All major changes and new features should bedeveloped on separate branches created from the dev_main branch. Namethese branches according to the feature or change they are meant toaddress.
• Development Branches: Our approach includes two developmentbranches, each serving distinct roles:
  • dev_main: This branch is the final integration stage beforechanges are merged into themain branch. It is considered stable,and only well-tested features and updates that are ready for thenext release cycle are merged here.
  • dev: This branch serves as a less stable, active developmentenvironment. Feature branches are merged here. Changes here are morefluid and this branch is at a higher risk of breaking.
• Main Branch (main): The main branch mirrors the stable state ofthe project as seen on CRAN. Only fully tested and approved changesfrom the dev_main branch are merged into main to prepare for a newrelease.

BGmisc is licensed under the GNU General Public License v3.0. For moredetails, see theLICENSE.mdfile.