disc_read: Raw data reading

Description Usage Arguments Details See Also

View source: R/disc_read.R

Description

Read data from various sensors and output somewhat uniformed records.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
disc_read(dir, ...)

## S3 method for class 'gt31'
disc_read(dir, ...)

## S3 method for class 'igotu'
disc_read(dir, ...)

## S3 method for class 'trackstick'
disc_read(dir, ...)

## S3 method for class 'gw52'
disc_read(dir, ...)

## S3 method for class 'dst'
disc_read(dir, ...)

## S3 method for class 'dstctd'
disc_read(dir, ...)

## S3 method for class 'ctdOpentag'
disc_read(dir, ...)

## S3 method for class 'ez'
disc_read(dir, ...)

## S3 method for class 'compassRemora'
disc_read(dir, ...)

## S3 method for class 'compassOpentag'
disc_read(dir, ...)

## S3 method for class 'cc'
disc_read(dir, ...)

## S3 method for class 'hobo'
disc_read(dir, ...)

## S3 method for class 'gopro'
disc_read(dir, ...)

## S3 method for class 'goproVideo'
disc_read(dir, ...)

## S3 method for class 'remoraAr'
disc_read(dir, ...)

Arguments

dir

path to the directory containing the files to read.

...

passed to other functions that do the actual reading, most often read.table.

Details

All methods of this generic function should takes the path to a directory (where the data is stored) as input and give a data.frame as output, with at least a column called dateTime of class POSIXct containing the date and time of that record. This column will be used to shift the data by a user configured offset (in disc_extract_deployments) and synchronise sensors. The rest of the columns depend on the sensors. The only constraint is for compass-type data to have a column named heading.

For instruments that output binary data (videos, audio files, etc.), the disc_read method should provide time stamps and paths to the various files. This information is then used by the appropriate disc_extract method to actually move/split/etc. the leg-level binary file into a file for each deployment.

See Also

disc_extract and disc_extract_deployments


jiho/discr documentation built on May 19, 2019, 9:30 a.m.