commit b4161ea2fe438a5e6c69bc7f2317f0b386d661d8
parent 5307b71a54c730d894c25915c801eeea051d3630
Author: eamoncaddigan <eamon.caddigan@gmail.com>
Date: Fri, 20 May 2016 16:53:08 -0400
"Well Clear", not "well-clear". I guess.
Diffstat:
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/R/calculateSLoWC.R b/R/calculateSLoWC.R
@@ -1,4 +1,4 @@
-#' Calculate the "severity loss of well-clear" (SLoWC) metric, described in RTCA
+#' Calculate the "severity loss of Well Clear" (SLoWC) metric, described in RTCA
#' SC-228 Closed-Loop Metrics White Paper.
#'
#' @param trajectory1 A \code{flighttrajectory} object corresponding to the
@@ -6,10 +6,10 @@
#' @param trajectory2 A \code{flighttrajectory} object corresponding to the
#' second aircraft.
#' @return The numeric vector giving the SLoWC metric. Values lie in the range
-#' [0, 100]. A SLoWC of 0 indicates well-clear, while a value of 100
+#' [0, 100]. A SLoWC of 0 indicates Well Clear, while a value of 100
#' corresponds to "full penetration" (i.e., a collision).
#'
-#' @details Note that the RTCA definition of well-clear is undergoing revision.
+#' @details Note that the RTCA definition of Well Clear is undergoing revision.
#' This code is based on the SLoWC formulation by Ethan Pratt and Jacob Kay as
#' implemented in a MATLAB script by Ethan Pratt dated 2016-04-18.
#'
diff --git a/man/calculateSLoWC.Rd b/man/calculateSLoWC.Rd
@@ -2,7 +2,7 @@
% Please edit documentation in R/calculateSLoWC.R
\name{calculateSLoWC}
\alias{calculateSLoWC}
-\title{Calculate the "severity loss of well-clear" (SLoWC) metric, described in RTCA
+\title{Calculate the "severity loss of Well Clear" (SLoWC) metric, described in RTCA
SC-228 Closed-Loop Metrics White Paper.}
\usage{
calculateSLoWC(trajectory1, trajectory2)
@@ -16,15 +16,15 @@ second aircraft.}
}
\value{
The numeric vector giving the SLoWC metric. Values lie in the range
- [0, 100]. A SLoWC of 0 indicates well-clear, while a value of 100
+ [0, 100]. A SLoWC of 0 indicates Well Clear, while a value of 100
corresponds to "full penetration" (i.e., a collision).
}
\description{
-Calculate the "severity loss of well-clear" (SLoWC) metric, described in RTCA
+Calculate the "severity loss of Well Clear" (SLoWC) metric, described in RTCA
SC-228 Closed-Loop Metrics White Paper.
}
\details{
-Note that the RTCA definition of well-clear is undergoing revision.
+Note that the RTCA definition of Well Clear is undergoing revision.
This code is based on the SLoWC formulation by Ethan Pratt and Jacob Kay as
implemented in a MATLAB script by Ethan Pratt dated 2016-04-18.
}