Add vignette for #34

[koheiw]

Address #34. I am not sure how to link vignette from the help page. Do you know @rcannood? Please also feel free to edit the vignette.

[codecov[bot]]

Codecov Report

Merging #40 (b99ea9d) into master (9f6a5d6) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #40   +/-   ##
=======================================
  Coverage   99.50%   99.50%           
=======================================
  Files           4        4           
  Lines         401      401           
=======================================
  Hits          399      399           
  Misses          2        2           

Impacted Files	Coverage Δ
R/proxy.R	99.12% <ø> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

[rcannood]

Afaik you can only link it as follows:

#' See the vignette for how the similarity and distance are computed:
#' `vignette("measures", package = "proxyC")`

However, pkgdown for instance will recognise this code and turn it into a URL on the fly.

[rcannood]

Also, you don't need to commit the R / html files of the vignette to this repo. When using usethis::use_vignette(...) to create a vignette, the following steps are run:

• Adds needed packages to DESCRIPTION.

• Adds inst/doc to .gitignore so built vignettes aren't tracked.

• Adds vignettes/*.html and vignettes/*.R to .gitignore so you never accidentally track rendered vignettes.

I'll make a PR to this PR for ease of use :)

[koheiw]

I will submit to the CRAN.