rename readMatrix function as readParmayMatrix

wadpac · Jan 23, 2025 · fa28ed9 · fa28ed9
1 parent 862957d
commit fa28ed9
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -3,7 +3,7 @@ export(readGenea, readAxivity, readGENEActiv,
        readActiGraphCount, readActiwatchCount,
        readActicalCount, readPHBCount,
        readFitbit, mergePHBdata,
-       mergeFitbitData, readMatrix)
+       mergeFitbitData, readParmayMatrix)
 useDynLib(GGIRread, .registration = TRUE)
 importFrom(Rcpp, sourceCpp)
 importFrom(data.table, fread)

diff --git a/R/readMatrix.R → R/readParmayMatrix.R b/R/readMatrix.R → R/readParmayMatrix.R
@@ -1,4 +1,4 @@
-readMatrix = function(bin_file, return = c("all", "sf", "dynrange")[1],
+readParmayMatrix = function(bin_file, return = c("all", "sf", "dynrange")[1],
                       start = 1, end = NULL,
                       desiredtz = "", configtz = NULL,
                       interpolationType = 1) {

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Brand | Device name | File extension | Data type | GGIRread function
 Axivity Ltd https://axivity.com/ | AX3 and AX6 | .cwa | raw gravitational units |readAxivity
 ActivInsights Ltd https://activinsights.com/ | GENEActiv Original and Sleep | .bin | raw gravitational units  | readGENEActiv
 Unilever Discover Ltd | Genea (no longer manufactured) | .bin | raw gravitational units | readGenea
-Parmay Tech https://www.parmaytech.com/ | Matrix | .bin | raw gravitational units | readMatrix
+Parmay Tech https://www.parmaytech.com/ | Matrix | .bin | raw gravitational units | readParmayMatrix
 ActiGraph | ??? | .csv | count data | readActigraphCount
 Actiwatch | ??? | .csv and .awd | count data | readActiwatchCount
 Actical | ??? | .csv | count data | readActicalCount

diff --git a/man/readMatrix.Rd → man/readParmayMatrix.Rd b/man/readMatrix.Rd → man/readParmayMatrix.Rd
@@ -1,13 +1,13 @@
-\name{readMatrix}
-\alias{readMatrix}
+\name{readParmayMatrix}
+\alias{readParmayMatrix}
 \title{Read and Process Binary Data from Matrix Devices}
 \description{
 Reads a binary file generated by Parmay Tech Matrix devices, processes its header and packet 
 data, validates data integrity using CRC32 checksums, and outputs structured 
 sensor data and quality check information.
 }
 \usage{
-readMatrix(bin_file, return = c("all", "sf", "dynrange")[1], start = 1, end = NULL,
+readParmayMatrix(bin_file, return = c("all", "sf", "dynrange")[1], start = 1, end = NULL,
            desiredtz = "", configtz = NULL, interpolationType = 1)
 }
 \arguments{
@@ -87,16 +87,16 @@ If \code{return = "dynrange"}, it returns the dynamic range of the accelerometer
 \dontrun{
 # Example usage:
 # Read full data and process all packets
-result <- readMatrix("example_file.bin")
+result <- readParmayMatrix("example_file.bin")
 
 # Get sampling frequency only
-sf <- readMatrix("example_file.bin", return = "sf")
+sf <- readParmayMatrix("example_file.bin", return = "sf")
 
 # Get accelerometer dynamic range
-dynrange <- readMatrix("example_file.bin", return = "dynrange")
+dynrange <- readParmayMatrix("example_file.bin", return = "dynrange")
 
-# Process a subset of packets with verbose output
-result_subset <- readMatrix("example_file.bin", start = 10, end = 20, verbose = TRUE)
+# Process a subset of packets
+result_subset <- readParmayMatrix("example_file.bin", start = 10, end = 20)
 }
 }
 \references{