-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathREADME.Rmd
More file actions
82 lines (61 loc) · 4.44 KB
/
README.Rmd
File metadata and controls
82 lines (61 loc) · 4.44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
options(citation.bibtex.max = 0)
```
# BGmisc
<!-- badges: start -->
<a href="https://r-computing-lab.github.io/BGmisc/"><img src="man/figures/hex.png" align="right" height="139" alt="discord website" /></a>
[](https://joss.theoj.org/papers/10.21105/joss.06203) </br>
[](https://www.repostatus.org/#active)
[](https://cran.r-project.org/package=BGmisc)
[](https://cran.r-project.org/web/checks/check_results_BGmisc.html)
[](https://cran.r-project.org/package=BGmisc)</br>
[](https://github.com/R-Computing-Lab/BGmisc/actions/workflows/R-CMD-check.yaml)
[](https://github.com/R-Computing-Lab/BGmisc/actions/workflows/R-CMD-dev_maincheck.yaml)
[](https://www.codefactor.io/repository/github/r-computing-lab/bgmisc)
[](https://app.codecov.io/gh/R-Computing-Lab/BGmisc)
<!-- badges: end -->
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](https://cran.r-project.org/) with:
```r
install.packages("BGmisc")
```
To install the development version of BGmisc from [GitHub](https://github.com/) use:
```r
# 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")
```
```{r,comment='',results='asis',echo=FALSE}
print(citation(package = "BGmisc"), style = "text", bibtex = FALSE)
```
A BibTeX entry for LaTeX users is
```{r,comment='',echo=FALSE}
toBibtex(citation(package = "BGmisc"))
```
## Contributing
Contributions to the BGmisc project are welcome. For guidelines on how to contribute, please refer to the [Contributing Guidelines](https://github.com/R-Computing-Lab/BGmisc/blob/main/CONTRIBUTING.md). 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](https://docs.gitlab.com/user/project/repository/branches/strategies/):
- **Feature Branches**: All major changes and new features should be developed on separate branches created from the dev_main branch. Name these branches according to the feature or change they are meant to address.
- **Development Branches**: Our approach includes two development branches, each serving distinct roles:
- **`dev_main`**: This branch is the final integration stage before changes are merged into the `main` branch. It is considered stable, and only well-tested features and updates that are ready for the next release cycle are merged here.
- **`dev`**: This branch serves as a less stable, active development environment. Feature branches are merged here. Changes here are more fluid and this branch is at a higher risk of breaking.
- **Main Branch** (`main`): The main branch mirrors the stable state of the project as seen on CRAN. Only fully tested and approved changes from the dev_main branch are merged into main to prepare for a new release.
## License
BGmisc is licensed under the GNU General Public License v3.0. For more details, see the [LICENSE.md](https://github.com/R-Computing-Lab/BGmisc/blob/main/LICENSE.md) file.