README.Rmd

---
output: github_document
#csl: https://raw.githubusercontent.com/citation-style-language/styles/master/ieee-aerospace-and-electronic-systems-magazine.csl
link-citations: true
references:
- id: gade_2010
  title: A Non-Singular Horizontal Position Representation
  author:
  - family: Gade
    given: Kenneth
  volume: 63
  issn: 0373-4633, 1469-7785
  URL:  'www.journals.cambridge.org/abstract_S0373463309990415'
  DOI: 10.1017/S0373463309990415
  issue: 03
  container-title: Journal of Navigation
  issued:
    year: 2010
    month: 07
  pages: 395-417
- id: navigationgroupatffi_2010
  title: The N-Vector Page
  URL: 'https://www.navlab.net/nvector/'
  issued:
    year: 2010
#    month: 07
  author:
  - family: Navigation Group
    given:  'FFI'
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```


# nvctr <img src="man/figures/logo.svg" align="right" height="139" />

<!-- badges: start -->
[![R build status](https://github.com/euctrl-pru/nvctr/workflows/R-CMD-check/badge.svg)](https://github.com/euctrl-pru/nvctr/actions)
[![CRAN version](https://www.r-pkg.org/badges/version/nvctr)](https://cran.r-project.org/package=nvctr)
<!-- badges: end -->


## Overview

The `nvctr` package implements the n-vector approach to geographical position calculations using an
ellipsoidal model of Earth as described in [@gade_2010].


Implementations in various computer languages can be found at the 
[n-vector page](https://www.navlab.net/nvector/) [@navigationgroupatffi_2010].


## Installation

You can install the development version of `nvctr` from 
[GitHub](https://github.com/euctrl-pru/nvctr) with:

```r
devtools::install_github("euctrl-pru/nvctr")
```

or the CRAN version (when this package will land to CRAN):

```r
install.packages("nvctr")
```


## Usage

`nvctr` can be used to solve geographical position calculation like (example numbers refer to the
ones in the [vignette][vignette]):

* Calculate the surface distance between two geographical positions ([Example 5][ex5]).
* Find the destination point given start point, azimuth/bearing and distance ([Example 8][ex8]).
* Find the mean position (center/midpoint) of several geographical positions ([Example 6][ex6]).
* Find the intersection between two paths ([Example 9][ex9]).
* Find the cross track distance between a path and a position ([Example 10][ex10]).



[vignette]: <https://nvctr.ansperformance.eu/articles/position-calculations.html> "nvctr vignette"
[ex5]: <https://nvctr.ansperformance.eu/articles/position-calculations.html#example-05> "Example 5: Surface distance"
[ex6]: <https://nvctr.ansperformance.eu/articles/position-calculations.html#example-6-interpolated-position> "Example 6: Interpolated position"
[ex8]: <https://nvctr.ansperformance.eu/articles/position-calculations.html#example-8-a-and-azimuthdistance-to-b> "Example 8: A and azimuth/distance to B"
[ex9]: <https://nvctr.ansperformance.eu/articles/position-calculations.html#example-9-intersection-of-two-paths> "Example 9: Intersection of two paths"
[ex10]: <https://nvctr.ansperformance.eu/articles/position-calculations.html#example-10-cross-track-distance-cross-track-error> "Example 10: Cross track distance (cross track error)"



## References