Skip to content

Commit

Permalink
Documentation Update w/ Roxygen2 v5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Jan 16, 2016
1 parent f431e67 commit 44f634b
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 44 deletions.
5 changes: 3 additions & 2 deletions DESCRIPTION
@@ -1,7 +1,7 @@
Package: imudata
Type: Package
Version: 0.1.1
Date: 2015-10-14
Version: 1.0.0
Date: 2016-01-16
Title: IMU Data Package for the GMWM Methods Package in R
Description: This package is meant to serve as a data collection for IMU data.
The data found here can be used within the GMWM methods R package to
Expand All @@ -20,3 +20,4 @@ Suggests:
gmwm
LazyData: yes
License: file LICENSE
RoxygenNote: 5.0.1
2 changes: 1 addition & 1 deletion NAMESPACE
@@ -1,3 +1,3 @@
# Generated by roxygen2 (4.1.1): do not edit by hand
# Generated by roxygen2: do not edit by hand

exportPattern("^[[:alpha:]]+")
13 changes: 5 additions & 8 deletions R/cont.imu1.R
@@ -1,17 +1,14 @@
#' @name cont.imu1
#' @title Containment IMU Data from a XSens MTi-G sensor
#' @description This data set contains gyroscope data
#' @docType data
#' @usage cont.imu1
#' @format A \code{matrix} with 500,000 observations and 1 variable. The variable is as follows:
#' \itemize{
#' \item{Gyro. X}{Gyroscope X-Axis}
#' \describe{
#' \item{\code{Gyro. X}}{Gyroscope X-Axis}
#' }
#' @source Geodetic Engineering Laboratory (TOPO), Swiss Federal Institute of Technology Lausanne (EPFL)
#' @author JJB
#' @examples
#' \dontrun{
#' data(cont_imu1)
#' summary(cont_imu1)
#' data(cont.imu1)
#' summary(cont.imu1)
#' }
NULL
"cont.imu1"
17 changes: 7 additions & 10 deletions R/imu6.R
@@ -1,16 +1,13 @@
#' @name imu6
#' @title IMU Data from a XSens MTi-G sensor
#' @description This data set contains gyroscope and accelerometer data from a XSens MTi-G sensor.
#' @docType data
#' @usage imu6
#' @format A \code{matrix} with 873,684 observations and 6 columns. The columns are defined as follows:
#' \itemize{
#' \item{Gyro. X}{Gyroscope X-Axis}
#' \item{Gyro. Y}{Gyroscope Y-Axis}
#' \item{Gyro. Z}{Gyroscope Z-Axis}
#' \item{Accel. X}{Accelerometer X-Axis}
#' \item{Accel. Y}{Accelerometer Y-Axis}
#' \item{Accel. Z}{Accelerometer Z-Axis}
#' \item{\code{Gyro. X}}{Gyroscope X-Axis}
#' \item{\code{Gyro. Y}}{Gyroscope Y-Axis}
#' \item{\code{Gyro. Z}}{Gyroscope Z-Axis}
#' \item{\code{Accel. X}}{Accelerometer X-Axis}
#' \item{\code{Accel. Y}}{Accelerometer Y-Axis}
#' \item{\code{Accel. Z}}{Accelerometer Z-Axis}
#' }
#' @source Geodetic Engineering Laboratory (TOPO), Swiss Federal Institute of Technology Lausanne (EPFL)
#' @author JJB
Expand All @@ -19,4 +16,4 @@
#' data(imu6)
#' summary(imu6)
#' }
NULL
"imu6"
8 changes: 4 additions & 4 deletions R/imudata.R
Expand Up @@ -8,18 +8,18 @@
#' \tabular{ll}{
#' Package: \tab gmwmdata\cr
#' Type: \tab Package\cr
#' Version: \tab 0.1.1\cr
#' Date: \tab 2015-10-14\cr
#' Version: \tab 1.0.0\cr
#' Date: \tab 2016-01-16\cr
#' License: \tab Q Public License\cr
#' }
#'
#' @author
#' James Balamuta \email{james.balamuta@@gmail.com},
#' James Balamuta \email{balamut2@@illinois.edu},
#' Stephane Guerrier \email{stephane@@illinois.edu},
#' Roberto Molinari \email{roberto.molinari@@unige.ch},
#' Wenchao Yang \email{wyang40@@illinois.edu}
#'
#' James Balamuta \email{james.balamuta@@gmail.com}
#' James Balamuta \email{balamut2@@illinois.edu}
#' @docType package
#' @name imudata
#' @exportPattern ^[[:alpha:]]+
Expand Down
1 change: 1 addition & 0 deletions imudata.Rproj
Expand Up @@ -15,3 +15,4 @@ LaTeX: pdfLaTeX
BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageRoxygenize: rd,collate,namespace
11 changes: 6 additions & 5 deletions man/cont.imu1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 8 additions & 7 deletions man/imu6.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions man/imudata.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 44f634b

Please sign in to comment.