studyParameters: Initial Parameters for QAQC

In qaqc: Quality Assurance and Quality Control Procedures for DICOM Data

Description

Define a number of important input parameters for the QAQC process using text-based input from the command line.

Usage

studyParameters(argList, date2process = NULL, emailList = NULL, study = NULL, inPath = file.path("", "cic_data", "Oncology"), outPath = file.path("", "scratch"), shared.area = NULL)

Arguments

argList	Text string from the “–args” call to Rscript.
date2process	Date (in DD-MM-YYYY format) to be processes. If no date is supplied, then today's date is used.
emailList	Text string of valid email addresses separated by commas.
study	Study ID.
inPath	Path name for input parameters.
outPath	Path name for output parameters.
shared.area	Path name for the Windows ‘shared area’ (default = NULL for local directory).

Value

List with the following elements:

today	is the date in YYYY-MM-DD format.
domDate	is the date in DD.MM.YYY format.
study	is a character string for the study ID.
logFile	is a character string for the log file.
domFile	is the path to the.
dicom	is the path to the Domain download directory.
nifti	is the path to the NIfTI directory. All dicom-to-nifti conversions will be placed in this directory.
shared.area	is an alternative location for the HTML output (intended to be a Windows-based shared area).
compare	is the user-specified file for verifyHeader.
emailList	is an email address for the notification to be sent.
mailText	is a character string containg the body of the email message.
css	is the name of the CSS file.

Author(s)

Brandon Whitcher [e-mail]

See Also

commandArgs, qaqc

Examples

args <- "--args study=\"MET111645\" date2process=\"22-03-2010\" inPath=\"/cic_data/Oncology\" outPath=\"/scratch\" sharedArea=\"//hlwsfshr10/sa200400214\" emailList=\"[e-mail],[e-mail]\""
unlist(studyParameters(args))

qaqc documentation built on May 2, 2019, 5:46 p.m.