Dark.Rcheck/00_pkg_src/Dark/README.md

In emkayoh/Dark: The Analysis of Dark Adaptation Data

Dark

Version 0.9.6

To Do

Test scripts

Build Status

Introduction

This package is being developed at the University of Manchester and is used to analyse data collected in dark adaptation measurements and experiments. The data are collected in the Optometry department of the University of Manchester in the Faculty of Life Sciences. The principal investigator is Dr Ian J Murray, other members of the team include Drs Jeremiah Kelly, Humza Tahir and Laura Patryas.

Data are collected using custom built laboratory devices and computer controlled CRT units. The results are stored usually as text or spreadsheet files. The first part of the workflow is to create a script that retrieves the data and presents it within R in a format that is usable.

The suite of scripts uses a list referred to as a dark object, an initial work through of the data input is shown below. A first GetData... script is shown in GetData.R. This script can be used as a template to create a script specific to your own work.

Acknowledgement

This work presents independent research funded by the National Institute for Health Research Invention for Innovation (NIHR i4i) Programme (ref: II-LB-0712-20001). The views expressed are those of the author(s) and not necessarily those of the NHS, the NIHR or the Department of Health.

Contact

The author of the package can be contacted through jeremiah.kelly at manchester.ac.uk or emkayoh at mac.com.

Getting started

The scripts rely on the generation of a dark object, obj. This is just a list with at least two elements; obj$time and obj$thrs.

Here is a way to do that using copy and paste from a spreadsheet.

Select the time data, then in R type;

obj<-NULL

obj$time<- scan()

then paste and press return.

obj<- NULL
obj$time<- scan()
1: 0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20
22: 
Read 21 items

repeat for the thresholds

obj$thrs<- scan()
1: 0.1453469 -0.6968675 -1.0072369 -1.0166411 -0.6266554 -0.9923025 -1.1308808 -1.3437734 -1.5006185 -1.5132403 -1.9454982 -2.1601161 -2.3190977 -2.9759416 -2.6118030 -2.6488100 -2.4796138 -3.0221779 -2.8277825 -2.9462043 -3.1657820
22: 
Read 21 items

Finally set the class to dark

class(obj)='dark'

The output should resemble this:

> obj
$thrs
 [1]  0.1453469 -0.6968675 -1.0072369 -1.0166411 -0.6266554 -0.9923025 -1.1308808
 [8] -1.3437734 -1.5006185 -1.5132403 -1.9454982 -2.1601161 -2.3190977 -2.9759416
[15] -2.6118030 -2.6488100 -2.4796138 -3.0221779 -2.8277825 -2.9462043 -3.1657820

$time
 [1]  0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20

attr(,"class")
[1] "dark"

email or raise an issue for further help.

emkayoh/Dark documentation built on May 16, 2019, 5:09 a.m.