Skip to content

Commit

Permalink
fix doc format [[,adp-method
Browse files Browse the repository at this point in the history
  • Loading branch information
dankelley committed Apr 30, 2018
1 parent e24b235 commit 88e5b67
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 35 deletions.
21 changes: 12 additions & 9 deletions R/adp.R
Original file line number Diff line number Diff line change
Expand Up @@ -523,17 +523,9 @@ setMethod(f="concatenate",
rval
})

#' @title Extract Something from of an adp Object
#'
#' In addition to the usual extraction of elements by name, some shortcuts
#' are also provided, e.g. \code{x[["u1"]]} retrieves \code{v[,1]}, and similarly
#' for the other velocity components. The \code{a} and \code{q}
#' data can be retrieved in \code{\link{raw}} form or numeric
#' form (see examples). The coordinate system may be
#' retrieved with e.g. \code{x[["coordinate"]]}.
#' @title Extract Something from an adp Object
#'
#' @param x An \code{adp} object, i.e. one inheriting from \code{\link{adp-class}}.
#' @template sub_subTemplate
#'
#' @examples
#' data(adp)
Expand All @@ -543,6 +535,17 @@ setMethod(f="concatenate",
#' adp[["a", "numeric"]][1:5,1,1]
#' as.numeric(adp[["a"]][1:5,1,1]) # same as above
#'
#' @template sub_subTemplate
#'
#' @section Details of the specialized \code{adp} method:
#'
#' In addition to the usual extraction of elements by name, some shortcuts
#' are also provided, e.g. \code{x[["u1"]]} retrieves \code{v[,1]}, and similarly
#' for the other velocity components. The \code{a} and \code{q}
#' data can be retrieved in \code{\link{raw}} form or numeric
#' form (see examples). The coordinate system may be
#' retrieved with e.g. \code{x[["coordinate"]]}.
#'
#' @author Dan Kelley
#'
#' @family things related to \code{adp} data
Expand Down
5 changes: 4 additions & 1 deletion R/adv.R
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ setMethod(f="summary",
#' head(adv[["q"]]) # in raw form
#' head(adv[["q", "numeric"]]) # in numeric form
#'
#' @template sub_subTemplate
#'
#' @section Details of the specialized \code{adv} method:
#'
#' In addition to the usual extraction of elements by name, some shortcuts
Expand All @@ -148,7 +150,8 @@ setMethod(f="summary",
#' \code{x[["heading"]]} interpolates to the faster timescale, using
#' \code{\link{approx}(timeSlow, headingSlow, time)}.
#'
#' @template sub_subTemplate
#' @author Dan Kelley
#'
#' @family things related to \code{adv} data
setMethod(f="[[",
signature(x="adv", i="ANY", j="ANY"),
Expand Down
20 changes: 12 additions & 8 deletions man/sub-sub-adp-method.Rd

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

37 changes: 20 additions & 17 deletions man/sub-sub-adv-method.Rd

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

0 comments on commit 88e5b67

Please sign in to comment.