GetData: GetData

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/GetData.R

Description

A template function that gets the data from a file and converts it to a dark object for use by other scripts. The script can be modified to format the data. A dark object has time data in minutes and thresholds in log units. If the data have been collected in other units then the script should convert them.

The script defaults to returning data generated by TestData.

Usage

1
GetData(path, .....)

Arguments

path

This is the location of the data and will usually be a file path string.

.....

This can be any other values that might be needed to identify the data, e.g. subject number or study reference.

Details

This script can be altered in any way desired and then saved with a different name. I suggest the format 'GetData....R', where the ellipsis describes the data in some way.

Value

A dark object with at least two elements

time

the time elapsed after measurements begin in minutes

thrs

the thresholds recorded in log units

other possible values include

data

the name of the data source

init

initial estimates of the optimal model parameters

opt

optimal estimates of the optimal model parameters

resid

the residuals of the data for an optimal model

...

others to be added

Author(s)

Jeremiah MF Kelly

Faculty of Life Sciences, The University of Manchester, M13 9PL, UK

See Also

TestData

Examples

1
2
set.seed(1234)
tmp <- GetData()

emkayoh/Dark documentation built on May 13, 2017, 6:05 p.m.