commit 722ae8e34cbb29656a6bd980201c0bdf3c3d58f8
parent 929857442d646d535c9e4610b2133700cb8ffd90
Author: eamoncaddigan <eamon.caddigan@gmail.com>
Date: Fri, 20 May 2016 17:00:28 -0400
Documenting identifyLoWC()
Diffstat:
3 files changed, 29 insertions(+), 1 deletion(-)
diff --git a/NAMESPACE b/NAMESPACE
@@ -2,5 +2,6 @@
export(calculateSLoWC)
export(createTrajectory)
+export(identifyLoWC)
export(identifyNMAC)
export(is.flighttrajectory)
diff --git a/man/identifyLoWC.Rd b/man/identifyLoWC.Rd
@@ -0,0 +1,27 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/identifyViolations.R
+\name{identifyLoWC}
+\alias{identifyLoWC}
+\title{Determine whether loss of Well Clear (LoWC) has occurred at each time point.}
+\usage{
+identifyLoWC(trajectory1, trajectory2)
+}
+\arguments{
+\item{trajectory1}{A \code{flighttrajectory} object corresponding to the
+first aircraft.}
+
+\item{trajectory2}{A \code{flighttrajectory} object corresponding to the
+second aircraft.}
+}
+\value{
+The logical vector indicating whether Well Clear has been violated at
+ each time point.
+}
+\description{
+Determine whether loss of Well Clear (LoWC) has occurred at each time point.
+}
+\details{
+This code relies on \code{\link{calculateSLoWC}}, see its
+ documentation for details.
+}
+
diff --git a/man/identifyNMAC.Rd b/man/identifyNMAC.Rd
@@ -1,5 +1,5 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/identifyNMAC.R
+% Please edit documentation in R/identifyViolations.R
\name{identifyNMAC}
\alias{identifyNMAC}
\title{Determine whether an NMAC (near mid air collision) has occurred at each time