README.md

In wbonat/mglm4twin: Multivariate Generalized linear Models for Twin Data

mglm4twin 0.3.0

The mglm4twin package fits multivariate generalized linear models for twin and family data. (Bonat and Hjelmborg, 2018).

Introduction

mglm4twin fits multivariate generalized linear models for twin and family data. It allows use a different linear predictor for each response variable of a multivariate response. The response variable can be continous or dicrete, like counts and binomial and also limited continuos or discrete/continuous inflated responses. The most important and relevant feature is that many covariance structures can be used to model the relations among different traits.

Download and install

Linux/Mac

Use the devtools package (available from CRAN) to install automatically from this GitHub repository:

library(devtools)
install_github("wbonat/mglm4twin")

Alternatively, download the package tarball: mglm4twin_0.3.0.tar.gz and run from a UNIX terminal (make sure you are on the container file directory):

R CMD INSTALL -l /path/to/your/R/library mglm4twin_0.3.0.tar.gz

Or, inside an R session:

install.packages("mglm4twin_0.3.0.tar.gz", repos = NULL,
                 lib.loc = "/path/to/your/R/library",
                 dependencies = TRUE)

Note that -l /path/to/your/R/library in the former and lib.loc = "/path/to/your/R/library" in the latter are optional. Only use it if you want to install in a personal library, other than the standard R library.

Windows

Download Windows binary version: mglm4twin_0.3.0.zip (do not unzip it under Windows), put the file in your working directory, and from inside R:

install.packages("mglm4twin_0.3.0.zip", repos = NULL,
                 dependencies = TRUE)

Development version

By default, if you use devtools::install_github(), or download any of the package tarball or Windows binary version, it will install the stable version of the package (from the master branch of this repository).

If you want to install the development version, you can use

library(devtools)
install_github("wbonat/mglm4twin", ref = "devel")

Note that the development version can contain bugs and other unknown features, so use it at your own risk!

Authors

• Wagner Hugo Bonat (author and main developer)

Documentation

The reference manual in PDF can be found here: mglm4twin-manual.pdf

Contributing

This R package is develop using [roxygen2][] for documentation and [devtools] to check and build. Also, we adopt the [Gitflow worflow][] in this repository. Please, see the instructions for contributing to collaborate.

License

This package is released under the GNU General Public License (GPL) v3.0.

See LICENSE

wbonat/mglm4twin documentation built on Oct. 14, 2023, 9:37 p.m.