get.tags.data: read TAGS formatted data

View source: R/data_import.R

get.tags.dataR Documentation

read TAGS formatted data

Description

Reads the data frame with detected twilight events into the FLightR

Usage

get.tags.data(
  filename = NULL,
  start.date = NULL,
  end.date = NULL,
  log.light.borders = "auto",
  log.irrad.borders = "auto",
  saves = c("auto", "max", "mean"),
  measurement.period = NULL,
  impute.on.boundaries = FALSE
)

Arguments

filename

the name of the file which the data are to be read from. File is supposed to be comma separated file of TAGS format. If it does not contain an absolute path, the file name is relative to the current working directory, getwd(). Tilde-expansion is performed where supported. This can be a compressed file (see file). Alternatively, file can be a readable text-mode connection (which will be opened for reading if necessary, and if so closed (and hence destroyed) at the end of the function call). File can also be a complete URL. For the supported URL schemes, see help for url.

start.date

date of beginning of relevant data collection in POSIXct format.

end.date

date of end of relevant data collection in POSIXct format.

log.light.borders

Numeric vector with length of 2 for minimum and maximum log(light) levels to use. Alternatively character value 'auto', that will allow FLightR to assign these values according to detected tag type.

log.irrad.borders

Numeric vector with length of 2 for minimum and maximum log(irradiance) values to use. Alternatively character value 'auto', that will allow FLightR to assign these values according to detected tag type.

saves

character values informing FLightR if min or max values were used by logger.

measurement.period

Value in seconds defining how often tag was measuring light levels. If NULL value will be taken from known values for detected tag type.

impute.on.boundaries

logical, if FLightR should approximate values at boundaries. Set it to TRUE only if you have vary few active points at each twilight, e.g if tag was saving every 10 minutes or so.

Details

The returned object has many parts, the important are: (1) the recorded light data, (2) the detected twilight events, (3) light level data at the moment of each determined sunrise and sunset and around them (24 fixes before and 24 after), and (4) technical parameters of the tag, i. e. its type, saving and measuring period (the periodicity, in seconds, at which a tag measures and saves data).

Value

list, which is to be further processed with the FLightR.

Examples

File<-system.file("extdata", "Godwit_TAGS_format.csv", package = "FLightR")
Proc.data<-get.tags.data(File)

FLightR documentation built on Oct. 3, 2023, 1:07 a.m.