flightconflicts

commit 3d131a37c0cfdeec57f7d209208059c5d5ee33f3
parent 377ca358eb1367770dada9b3d0c65a91534b8272
Author: eamoncaddigan <eamon.caddigan@gmail.com>
Date:   Fri, 20 May 2016 11:47:06 -0400

Add return value to documentation

Diffstat:
M
R/createTrajectory.R
 | 
8
+++++---
M
man/createTrajectory.Rd
 | 
8
++++++--

2 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/R/createTrajectory.R b/R/createTrajectory.R
@@ -1,4 +1,4 @@
-#' Create a flighttrajectory object from the flight info. 
+#' Create a flighttrajectory object from the flight info.
 #' 
 #' @param longitude Required; numeric vector giving aircraft longitude in 
 #'   degrees.
@@ -13,10 +13,12 @@
 #' @param groundspeed Optional; numeric vector giving the current ground speed 
 #'   of the aircraft in knots. If missing, it is estimated using pairs of 
 #'   successive lon/lat observations.
+#' @return A flighttrajectory object encapsulating these parameters (with
+#'   default values substituded as necessary).
 #'   
 #' @details \code{longitude} and \code{latitude} must be the same length. 
-#'   \code{timestamp}, \code{bearing}, and \code{groundspeed}, if present, must
-#'   also match this length. \code{altitude} must also have a length equal to
+#'   \code{timestamp}, \code{bearing}, and \code{groundspeed}, if present, must 
+#'   also match this length. \code{altitude} must also have a length equal to 
 #'   these parameters or be scalar.
 #'   
 #' @export
diff --git a/man/createTrajectory.Rd b/man/createTrajectory.Rd
@@ -27,13 +27,17 @@ observations.}
 of the aircraft in knots. If missing, it is estimated using pairs of 
 successive lon/lat observations.}
 }
+\value{
+A flighttrajectory object encapsulating these parameters (with
+  default values substituded as necessary).
+}
 \description{
 Create a flighttrajectory object from the flight info.
 }
 \details{
 \code{longitude} and \code{latitude} must be the same length. 
-  \code{timestamp}, \code{bearing}, and \code{groundspeed}, if present, must
-  also match this length. \code{altitude} must also have a length equal to
+  \code{timestamp}, \code{bearing}, and \code{groundspeed}, if present, must 
+  also match this length. \code{altitude} must also have a length equal to 
   these parameters or be scalar.
 }