get_residuals: get_residuals

View source: R/get_residuals.R

get_residualsR Documentation

get_residuals

Description

This function retrieve residual values from an lmerFit summary object and plot residual values by condition_column

Note: The current version does not accept categorical response variables, sample size parameters smaller than the observed samples size

Usage

get_residuals(
  data,
  condition_column,
  experimental_columns,
  response_column,
  condition_is_categorical,
  repeatable_columns = NA,
  response_is_categorical = FALSE,
  family = NULL
)

Arguments

data

Input data

condition_column

Name of the condition variable (ex variable with values such as control/case). The input file has to have a corresponding column name

experimental_columns

Name of variables related to experimental design such as "experiment", "plate", and "cell_line". "experiment" should come always first

response_column

Name of the variable observed by performing the experiment. ex) intensity.

condition_is_categorical

Specify whether the condition variable is categorical. TRUE: Categorical, FALSE: Continuous.

repeatable_columns

Name of experimental variables that may appear repeatedly with the same ID. For example, cell_line C1 may appear in multiple experiments, but plate P1 cannot appear in more than one experiment

response_is_categorical

Default: the observed variable is continuous Categorical response variable will be implemented in the future. TRUE: Categorical , FALSE: Continuous (default).

family

The type of distribution family to specify when the response is categorical. If family is "binary" then binary(link="log") is used, if family is "poisson" then poisson(link="logit") is used, if family is "poisson_log" then poisson(link=") log") is used.

Value

A linear mixed model result


gladstone-institutes/CalcPower documentation built on Jan. 3, 2023, 11:27 a.m.