check_normality: check_normality

View source: R/check_normality.R

check_normalityR Documentation

check_normality

Description

This function makes a quantile-quantile (qq) plot of the residual values of the mixed effects model. Users can check the normality of residual values by examining qqplot.

Usage

check_normality(
  data,
  condition_column,
  experimental_columns,
  response_column,
  condition_is_categorical,
  repeatable_columns = NA,
  response_is_categorical = FALSE,
  image_title = 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 the variable related to experimental design such as "experiment", "plate", and "cell_line".

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).

image_title

title of the qq plot

Value

A quantile-quantile (qq) plot of residual values in a mixed-effects model

Examples

check_normality(data,"classif",c("experiment","line"),"feature1","TRUE")

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