install_github with build_vignettes = TRUE?

[tscheypidi]

It seems that by default the supplied vignette is not being installed when running devtools::install_github('JGCRI/ambrosia')

I would suggest to ask users to run devtools::install_github('JGCRI/ambrosia', build_vignettes = TRUE) instead.

Doing so would also allow to refer to the vignette via the command vignette("ambrosia_vignette") instead of referring to the vignettes directory.

(this is related to openjournals/joss-reviews#2890)

[kanishkan91]

@tscheypidi Thank you for this comment. We have added the same to the instructions along with instructions on directly loading the vignette.

[tscheypidi]

I would recommend to put the vignette call statement into the "User tutorial and examples" section below. Otherwise, it might be confusing for the user why it is first suggested to call the vignette via vignette("ambrosia_vignette") but directly afterwards suggested to navigate to the vignette file using its physical location on the system.