emptyABT: Production of an empty xlsx file in which experimental...

View source: R/emptyABT.R

emptyABTR Documentation

Production of an empty xlsx file in which experimental results should be recorded.

Description

AntibodyTiters requires the input xlsx files be in a specific format. This function produces an empty xlsx file in the format.

Usage

emptyABT(fileName = "empty.xlsx", pmax = 7, returnDF = FALSE, 
	Attrib = c("Sex", "Age", "VeryLow"), 
	attribFactors = list(c("F", "M"), c(18, 80), c(TRUE, FALSE)))
	

Arguments

fileName

a file name to be produced.

pmax

an integer (>=4 & <18) for specifying the maximam sampling point.

returnDF

a logical value indicating whether a data.frame is returned instead of being stored as an xlsx file.

Attrib

a character vector for the names of Attrib.

attribFactors

a list determining the values of Attrib. If the names of Attrib contained "Age", two numbers provided here are used as lower and upper limits.

Value

When the argument returnDF is FALSE (default), an xlsx file will be stored in the current directory. When returnDF is TRUE, a data.frame will be returned.

Examples

# emptyABT(fileName = "empty.xlsx", pmax = 7, returnDF = FALSE, 
# 	Attrib = c("Sex", "Age", "VeryLow"), 
# 	attribFactors = list(c("F", "M"), c(18, 80), c(TRUE, FALSE)))
# The above command will create an empty excel file named empty.xlsx 
# in the current directory. 

AntibodyTiters documentation built on May 24, 2022, 5:05 p.m.