coverAndKeyPlot: Plot a cover sheet

View source: R/functions_imagesQC.R

coverAndKeyPlotR Documentation

Plot a cover sheet

Description

This function (from functions_imagesQC.R) plots a cover sheet, and one or more key sheet indicating the links between CEL file names, array names used in the plots, and to which experimental group they belong based on the description file provided by the user, which has been loaded into the description variable earlier in the main script, passed as an argument (arrayGroup). For the key sheets, one sheet will be created for every 35 arrays in the experiment.

Usage

coverAndKeyPlot(description = NULL, refName = "", WIDTH = 1000, HEIGHT = 1414)

Arguments

description

(Status: required) The data.frame containing the description file information (column 1: file names; column 2: names to be used in the plots; column 3: experimental groups the samples belong to)(datatype: data.frame)

refName

(Status: optional, Default:"") dataset name. It is deduced from the name of the zip file containing the CEL files when used from arrayanalysis.org or as a GenePattern module.(datatype: character)

WIDTH

(Status: optional, Default:1000) png image width (datatype: number)

HEIGHT

(Status: optional, Default:1414) png image height (datatype: number)

Value

Two files, a file called ‘Cover_1’ that can be used as an opening image.And, file(s) called ‘Description’, if needed followed by an index number,that represent(s) the information as given in the input parameter.

Examples

# By default, the script will call:
# coverAndKeyPlot(description)

ammar257ammar/ArrayAnalysis-Bioconductor documentation built on Jan. 29, 2024, 7:21 a.m.