arbin_import: arbin_import

In mjlacey/arbintools: Matt Lacey's Arbin Importing and Plotting Functions

Description

This function takes an exported data file in Microsoft Excel format, discards or includes certain data depending on the options chosen in the function, and returns a list of two data frames: the complete raw data and an aggregated statistics file. The statistics are aggregated from the raw data alone; the statistics sheet as outputted to the Excel file is not read.

Usage

arbin_import(file, step.time = TRUE, energy = TRUE, cycles = 100,
  mass = NULL, meanE = FALSE)

Arguments

file	The filename, which must end in .xls or .xlsx.
step.time	Defaults to TRUE. Includes the step time variable from the data file if TRUE.
energy	Defaults to TRUE. Includes the (dis)charge energy variables from the data file if TRUE.
cycles	Defaults to 100. Determines the maximum number of cycles to be considered when aggregating the statistics dataset.
mass	Defaults to NULL. If an active material mass is specified - in MILLIGRAMS - the capacities in the raw and statistics data frames will be converted to mAh/g.
meanE	Defaults to FALSE. Will calculate a statistic for average charge and discharge voltage if set to TRUE.

Examples

mydataset <- arbin_import("dataset.xlsx")
mydataset <- arbin_import("dataset.xlsx", step.time = FALSE, cycles = 200, mass = 2.55)

mjlacey/arbintools documentation built on May 23, 2019, 1:04 a.m.