tdmsread: Data Stream (.tdms Format) Reading Function

In abhishekhanchate/readTDMS: R-based TDMS file format reader and analyzer

Description

The function reads in an TDMS file as an input. The destination/folder of the file must be specified and its associated TDMS_Index file must be present in the same folder.

Usage

tdmsread(file_input, plot = FALSE)

Arguments

file_input	is an TDMS file Input
plot	is a boolean indicating if plotting is desired

Value

The function returns a list containing:

• datastream - A vector of data stream values based on the input TDMS file

• timestamps - A vector of time stamps associated with the datastream based on the input TDMS file

• summ - The summary of the extracted data stream

• img - The Time domain plot of the data stream

Examples

# Load the installed library/package
library(readTDMS)
# Open the TDMS File with specified path
f <- file('~/readTDMS/vignettes/data/file.tdms', 'rb')
# Call the Function to get the required plot
ans <- tdmsread(f)
# Datastream values
ans$datastream
# Timestamps
ans$timestamps
# Close the file if needed
# Note: For any changes and rerun of about function, we need to reopen the TDMS file
close(f)

abhishekhanchate/readTDMS documentation built on Dec. 18, 2021, 9:30 p.m.