header.info {GENEAread}

Get header info from GENEA output (.bin) file

Description

Function to extract relevant header fields and values from a file.

Usage

header.info(binfile, more=TRUE)

Arguments

binfile

The file from which to extract the header

more

logical. If TRUE, extract additional data from file useful for calibration and data reading.

Details

The function extracts useful information from a .bin file, such as information about the GENEA device used to produce the output, and characteristics of the subject who wore the device. The function also accepts data that has been compressed in ‘gzip’, ‘bzip2’ or ‘xz’ formats. See file. With more set to TRUE, additional data is extracted, mainly for internal use in read.bin.

THis function is specific to header structure in GENEActiv output files. By design, it should be compatible with all firmware and software versions to date (as of version of current release). If order or field names are changed in future .bin files, this function may have to be updated appropriately. The function works by looking for appropriate section headings in the .bin files.

Value

A data.frame with extracted header information, each row a particular header field with its value. If more is TRUE, an attribute "calibration" is attached to the object, consisting of a list with measurement offsets, sampling frequency estimates, start times and time zones, data position offsets, and if mmap is detected, byte locations and increments for mmap reading.

Warning

NA

See Also

read.bin

Examples

fileheader <- header.info(system.file("binfile/TESTfile.bin",
                                      package = "GENEAread")[1],
                                      more = TRUE)
print(fileheader)
attr(fileheader, "calibration")