flux-class: An S4 class to represent sapflux data and its associated...

Description Usage Methods (by generic) Slots

Description

Defines the 'flux' class for use in sapflux package functions.

The 'flux' object class stores all the information relevant to an analysis of sapflux data in one form, and allows the use of seperate methods for plot, print, and summary.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
## S4 method for signature 'flux'
initialize(.Object, ...)

## S4 method for signature 'flux'
plot(x, y, ...)

## S4 method for signature 'flux'
summary(object, ...)

## S4 method for signature 'flux'
identify(x, y = NULL, labels = seq_along(x), pos = FALSE,
  n = length(x), plot = TRUE, atpen = FALSE, offset = 0.5,
  tolerance = 0.25, ...)

## S4 method for signature 'flux'
head(x, n = 6L, ...)

## S4 method for signature 'flux'
str(object, ...)

Methods (by generic)

Slots

raw_data

The raw sapflux data sourced by FluxImport. Redundant and optional.

source_files

A character vector of the filenames sourced by FluxImport, in order of import.

data

The pre- and post-processed sapflow data, with each column representing a unique probe and unique metadata identifier.

time

Time vector associated with the sapflux data.

date

As time, but for dates.

datatype

The kind of data in the 'data/raw_data' slot. Can be: voltages, temperatures, flux index, flux density, stem flux, plant flux, stand flux, or land flux.

Each data.type has processing parameter defaults, set in "./data/sapflux_datatype_defaults.csv".

metadata

A dataframe of metadata, with each row associated with a unique identifier that maps to a single column in the processed sapflux data.

log

Character vector of log outputs.


bmcnellis/sapflux documentation built on May 12, 2019, 10:27 p.m.