micropem: An R6 class to represent MicroPEM output information.

In masalmon/RTImicropem: Supports the Analysis of RTI MicroPEM Output Files

An R6 class to represent MicroPEM output information.

Description

An R6 class to represent MicroPEM output information.

Usage

micropem

Format

R6Class object.

Value

Object of R6Class.

Fields

settings

Data.frame (dplyr "tbl_df") with settings of the micropem device and other information such as download time.

calibration

List of calibration information.

filename

Filename from which the object was built.

measures

Data.frame (dplyr "tbl_df") with all time-varying measures, possibly:

datetime

Time and date of each measurement, as a POSIXt object. Depending on the different logs of the time-varying variables there is not a measure for all variables associated to each timepoint.

rh_corrected_nephelometer

Measures of nephelometer in microgram/meter cube (numeric).

temp

Measures of temperature in centigrade (numeric).

rh

Measures of relative humidity that are a proportion and as such do not have an unit (numeric).

battery

Measures of battery in Volt (numeric).

orifice_press

Measures of orifice pressure in inches of water (numeric).

inlet_press

Measures of inlet pressure in inches of water (numeric).

flow

Measures of flow in liters per minute (numeric).

x_axis

x-axis accelerometer in m/s2 (numeric).

y_axis

y-axis accelerometer in m/s2 (numeric).

z_axis

z-axis accelerometer in m/s2 (numeric).

vector_sum_composite

vector sum m/s2 (numeric).

message

Shutdown reason (factor).

original

Boolean. Is this an original micropem object (TRUE) or was it e.g. filtered or cleaned (FALSE).

Methods

plot

Method for getting a quick plot of all time-varying measurements. Either type ="plain" or type ="interactive", see examples. The method returns a plot of the ggplot-class. One can add a title via the title argument.

summary

Method for getting a summary table (dplyr "tbl_df") of all time-varying numeric measurements.

print

Method for printing both the summary table of all time-varying numeric measurements and all settings from the settings field.

Examples

data("micropemChai")
# Plot method, type = "plain" by default.
micropemChai$plot()
# Example with type = "interactive", for RStudio viewer,
# RMardown html documents and Shiny apps.
## Not run: 
library("rbokeh")
p <- micropemChai$plot(type = "interactive")
p
# Summary method
micropemChai$summary()
# Print method
micropemChai$print()

## End(Not run)

masalmon/RTImicropem documentation built on May 17, 2022, 4:46 a.m.