Update README: vignette missing

[rkuttnerFHCR]

Instructions for including vignette are not correct.

devtools::install_github("FredHutch/VISCtemplates", build_vignettes = TRUE)
vignette("using_pdf_and_word_template")
#> Warning message:
#> vignette ‘using_pdf_and_word_template’ not found 
browseVignettes("VISCtemplates")
#> No vignettes found by browseVignettes("VISCtemplates")

To include the vignettes:

devtools::install_github("FredHutch/VISCtemplates", 
                                      build_opts = c("--no-resave-data", "--no-manual"))
vignette("using_pdf_and_word_template")

[wfulp]

The build_vignettes works for me 🤷. I'm not sure what the difference is.

[rkuttnerFHCR]

It may have to do with which version of the devtools package you are using. I found this issue with the following quote from member of the R infrastructure team Jim Hester,

post by @jimhester in r-lib/devtools#1896 (comment)

Yes, remove --no-build-vignettes from the build_opts to build the vignettes. e.g.

devtools::install_github("foo/bar", build_opts = c("--no-resave-data", "--no-manual"))

[wfulp]

It may have to do with which version of the devtools package you are using. I found this issue with the following quote from member of the R infrastructure team Jim Hester,

post by @jimhester in r-lib/devtools#1896 (comment)

Yes, remove --no-build-vignettes from the build_opts to build the vignettes. e.g.

devtools::install_github("foo/bar", build_opts = c("--no-resave-data", "--no-manual"))

It looks to be fixed in the remotes package:

  if (!isTRUE(build_vignettes)) {
    build_opts <- union(build_opts, "--no-build-vignettes")
  } else {
    build_opts <- setdiff(build_opts, "--no-build-vignettes")
  }

https://github.com/r-lib/remotes/blob/master/R/install.R (line 87)

[wfulp]

Found the issue (r-lib/remotes#353)

[rkuttnerFHCR]

Nice!
Looks like the problem was fixed in version 2.1.0 in the remotes package.

[wfulp]

We should change it to remotes though

[rkuttnerFHCR]

devtools::install_github() is a wrapper around remotes.

They differ only that the ones in devtools use the ellipsis package to ensure all dotted arguments are used.

So it's fine to leave the README as is.

[rkuttnerFHCR]

On the other hand, it is more consistent to use remotes for both instructions and requires less of the user.

[wfulp]

Thanks @rkuttnerFHCR for catching this. I fixed it in #58