summary_xvg {xvm} | R Documentation |
summarize xvg data compute basic summary statistics (mean, sd, min, median, max) for each variable in one or more xvg_data objects.
Description
summarize xvg data compute basic summary statistics (mean, sd, min, median, max) for each variable in one or more xvg_data objects.
Usage
summary_xvg(xvg_data, merge_results = FALSE)
Arguments
xvg_data |
a list of class 'xvg_data' or a list containing multiple 'xvg_data' objects, as returned by |
merge_results |
logical, whether to combine results from multiple objects (default: FALSE). When TRUE, results will include a 'group' column identifying the source. |
Value
a data.frame with columns:
- group
(Optional) Source identifier when processing multiple objects with merge_results=TRUE.
- variable
Name of the variable (column) in the xvg data.
- mean
Arithmetic mean of that variable.
- sd
Standard deviation.
- min
Minimum value.
- median
Median value.
- max
Maximum value.
Examples
path <- system.file("extdata/rmsd.xvg", package = "xvm")
xvg_data <- read_xvg(path)
summary_xvg(xvg_data)
[Package xvm version 0.0.2 Index]