createDataframe {diskImageR}R Documentation

Dataframe creation

Description

createDataframe saves the calculated resistance, perseverence and sensitivity estimates

Usage

createDataframe(projectName, clearHalo, diskDiam = 6, maxDist = 30,
  standardLoc = 2.5, removeClear = FALSE, nameVector = TRUE,
  typeVector = TRUE, typePlace = 2, typeName = "type")

Arguments

projectName

the short name in use for the project.

clearHalo

numeric value that indicates which picture should be used to represent a clear halo (i.e., the clear space beside the disk).

diskDiam

the diameter of the diffusion disk in mm, defaults to 6.

maxDist

a numeric value indicating the maximum distance away from the disk to be considered. Defaults to 30mm.

standardLoc

a numberic value indicating the location (on the disk) to use to standardize intensity across photographs. The position of standardLoc is a position that should theoretically have the same intensity in all photographs, i.e., the white of the disk. The defaul value (2.5mm) was chosen after testing of 6mm disks that contain some writing. If smaller disks are used standardLoc should be scaled appropriately. You can see where standardLoc falls in each photograph in plotRaw (the red dashed line). To suppress this standardization use standardLoc = FALSE.

removeClear

a logical value that indicates whether to remove the clear halo picture from the dataset (i.e., is this picture an experimental picture, or one solely included to use as a clear halo). Defaults to FALSE.

nameVector

either a logial value or a character vector. Supported values are nameVector = "TRUE" to assign the photograph name to the 'name' column, nameVector = "FALSE" to assign th photograph number to the 'name' column, or nameVector = a vector the same length as the number of photographs indicating the desired names.

typeVector

a logical value. typeVector = "TRUE" will add a 'type' vector to the dataframe using values found in the typePlace position of the photograph names (see IJMacro for more details) while typeVector = "FALSE" will not add a type column.

typePlace

a number that indicates the position of the photograph name to be stored as the 'type' vector'. Defaults to 2. For more details see IJMacro

typeName

a character string that indicates what to name the typeVector. Defaults to "type".

Details

A dataframe with 11 columns:

Value

A dataframe "projectName.df" is saved to the global environment and a .csv file "projectName_df.csv" is exported to the "parameter_files" directory.

Examples

## Not run: 
createDataframe("myProject", clearHalo=1)
createDataframe("myProject", clearHalo=1, removeClear = TRUE, typeName = "drugAmt")

## End(Not run)

[Package diskImageR version 1.0.0 Index]