R/ThetaFromGreatCircleDistance.R

Defines functions ThetaFromGreatCircleDistance

Documented in ThetaFromGreatCircleDistance

#' Get theta from great circl distance
#'
#' Returns theta in radians from a great circle distance in kilometres
#' @param great_circle_distance The great circle distance in kilometres.
#' @param EarthRad Radius of the Earth in kilometres.
#' @return Theta in radians.
#' @details Nothing yet.
#' @author Graeme T. Lloyd \email{graemetlloyd@@gmail.com}
#' @export
#'
#' @examples
#' ThetaFromGreatCircleDistance(1000)

# Get theta in radians from great circle distance:
ThetaFromGreatCircleDistance <- function(great_circle_distance, EarthRad = 6367.4447) {
	
	# Get theta in radians from great circle distance:
	great_circle_distance / EarthRad
	
}
laurasoul/dispeRse documentation built on May 25, 2021, 4:50 a.m.