R/GreatCircleDistanceFromTheta.R

Defines functions GreatCircleDistanceFromTheta

Documented in GreatCircleDistanceFromTheta

#' Returns great circle distance from theta
#'
#' Returns great circle distance in kilometres from theta in radians
#'
#' @param theta Theta in radians.
#' @param EarthRad Radius of the Earth in kilometres.
#' @return Great circle distance in kilometres.
#' @details Nothing yet.
#' @author Graeme T. Lloyd \email{graemetlloyd@@gmail.com}
#' @export
#' @examples
#' GreatCircleDistanceFromTheta(0.5)

# Get great circle distacne from theta in radians and radius in km:
GreatCircleDistanceFromTheta <- function(theta, EarthRad = 6367.4447) {
	
	# Calculate great circle distance from theta in radians:
	theta * EarthRad
	
}
laurasoul/dispeRse documentation built on May 25, 2021, 4:50 a.m.