plotEachABT {AntibodyTiters}R Documentation

Plotting antibody titers of each patient.

Description

This function plots antibody titers of one specified patient in the ABT class object produced by readABT.

Usage

plotEachABT(patientID = "patient A", objName = "inData", 
    prefix = "", dayStart = as.integer(NA), dayEnd = as.integer(NA), 
    type = "weeks", ylab = "Titer (AU/ml)", savePDF = FALSE, addPoints = FALSE, lwd = 2, 
    logY = TRUE, PDFwidth = 8, PDFheight = 5, main = NULL)

Arguments

patientID

a character specifying the patient to be plotted.

objName

a character specifying the name of an ABT class object produced by readABT.

prefix

a character to be atattched to the file name. This is active when savePDF==TRUE.

dayStart

an integer specifying the start day, from which scores are plotted.

dayEnd

an integer specifying the end day, to which scores are plotted.

type

a character determining the time scale; "weeks" or "days". There is no discrete mode (e.g. M1) for this function.

ylab

a character for the y-axix label.

savePDF

a logical indicating whether a PDF file is stored in the current directory.

addPoints

a logical indicating whether points are added.

lwd

an integer for controlling the width of lines.

logY

a logical indicating whether Y-axis is in log scale.

PDFwidth

an integer specifying the width of PDF. This is active when savePDF==TRUE.

PDFheight

an integer specifying the height of PDF. This is active when savePDF==TRUE.

main

a character for the main title. When not specified, patientID and objName will be used as the title.

Value

No object will be returned. Instead, this function will drow a plot in a graphic device, or save a PDF file in the current directory.

Examples

inData <- readABT(fileName = system.file("extdata","toy.xlsx",package="AntibodyTiters"))
plotEachABT(patientID = "patient 2", objName = "inData", 
    dayStart = as.integer(NA), dayEnd = as.integer(NA), type = "weeks", savePDF = FALSE)
plotEachABT(patientID = "patient 2", objName = "inData", 
    dayStart = as.integer(NA), dayEnd = as.integer(NA), type = "weeks", savePDF = FALSE, 
    lwd = 2)
plotEachABT(patientID = "patient 2", objName = "inData", 
    dayStart = as.integer(NA), dayEnd = as.integer(NA), type = "weeks", savePDF = FALSE, 
    addPoints = TRUE)
plotEachABT(patientID = "patient 2", objName = "inData", 
    dayStart = as.integer(NA), dayEnd = as.integer(NA), type = "days", savePDF = FALSE)
plotEachABT(patientID = "patient 2", objName = "inData", 
    dayStart = 140, dayEnd = 350, type = "weeks", savePDF = FALSE)
plotEachABT(patientID = "patient 2", objName = "inData", 
    dayStart = 140, dayEnd = 350, type = "days", savePDF = FALSE)

[Package AntibodyTiters version 0.1.24 Index]