RunGLM: Runs generalized linear model on a puddlr object. Intended...

View source: R/puddlr.R

RunGLMR Documentation

Runs generalized linear model on a puddlr object. Intended to be run after normalization and removal of incomplete observations.

Description

Runs generalized linear model on a puddlr object. Intended to be run after normalization and removal of incomplete observations.

Usage

RunGLM(puddlr, formula, family, reduction, n.components, adj.rsq = FALSE)

Arguments

puddlr

A puddlr object

formula

an object of class "formula" (or one that can be coerced to that class): a symbolic description of the model to be fitted. The details of model specification can be found under 'glm'. The name of the response variable in the formula will be used to name the response variable.

family

a description of the error distribution and link function to be used in the model. Passed to the argument of the same name under 'glm'.

reduction

a string specifying the linear dimensionality reduction to use. Valid options are 'pca'. Default = 'pca'

n.components

an integer specifying the total number of reduction components to use in the GLM.

adj.rsq

boolean flag specifying whether to adjust the pseudo-R^2 goodness-of-fit calculated value.

Value

puddlr object with glm


rahuldhodapkar/puddlr documentation built on May 28, 2022, 12:53 p.m.