qqr: Creates a qq object

Description Usage Arguments Value Note Source See Also Examples

View source: R/qqr.R

Description

An object of class qq includes all the needed information for producing a quantile-quantile plot of p-values. The goal is to seperate the pre-processing of the quantile-quantile plot elements from the graphical rendaring of the object, which could be done using any graphical device including plot_ly and plot in base R.

Usage

1
qqr(x, p = "P", snp, gene, annotation1, annotation2, ...)

Arguments

x

A data.frame which must contain at least the following column:

  • a p-value, must be numeric

p

A string denoting the column name for the p-values. Default is p = "P". This column must be numeric or integer. Should not have missing, NA, NaN, or NULL values and should be between 0 and 1.

snp

A string denoting the column name for the SNP names (e.g. rs number). More generally, this column could be anything that identifies each point being plotted. For example, in an Epigenomewide association study (EWAS) this could be the probe name or cg number. This column should be a character. This argument is optional, however it is necessary to specify if you want to highlight points on the plot using the highlight argument in the qqly function

gene

A string denoting the column name for the GENE names. This column could be a character or numeric. More generally this could be any annotation information that you want to include in the plot. This argument is optional.

annotation1

A string denoting the column name for an annotation. This column could be a character or numeric. This could be any annotation information that you want to include in the plot (e.g. zscore, effect size, minor allele frequency). This argument is optional.

annotation2

A string denoting the column name for an annotation. This column could be a character or numeric. This could be any annotation information that you want to include in the plot (e.g. zscore, effect size, minor allele frequency). This argument is optional.

...

currently ignored

Value

An list object of class qqr with the following elements

data

processed data to be used for plotting the Q-Q plot including the observed and expected p-values on the -log10 scale

pName, snpName, geneName, annotation1Name, annotation2Name

The names of the columns corresponding to the data provided. This information is used for annotating the plot in the qqly function

Note

This function will return an error if any of the p-values are NA, less than 0 or greater than 1

Source

The calculation of the expected p-value is taken from the qq function from the qqman package by Stephen Turner

See Also

qqly

Examples

1
2
3
4
library(manhattanly)
qqrObj <- qqr(HapMap, snp = "SNP", highlight = significantSNP)
class(qqrObj)
head(qqrObj[["data"]])

sahirbhatnagar/manhattanly documentation built on Dec. 17, 2017, 12:11 p.m.