search

ococrook / bandle

An R package for Bayesian analysis of differential localisation experiments
https://ococrook.github.io/bandle/
5 stars 1 forks source link

updates readme for vignette installation #9

Closed TomSmithCGAT closed 2 years ago

TomSmithCGAT commented 2 years ago

Currently, suggested installation will not install vignettes. Adding build_vignettes=TRUE to install command gives the following error 

Error: Failed to install 'bandle' from GitHub:
  System command 'R' failed, exit status: 1, stdout + stderr (last 10 lines):
E> --- re-building ‘bandle-vignette-getting-started.Rmd’ using rmarkdown
E> Error: processing vignette 'bandle-vignette-getting-started.Rmd' failed with diagnostics:
E> The 'rmarkdown' package should be installed and declared as a dependency of the 'bandle' package (e.g., in the 'Suggests' field of DESCRIPTION), because the latter contains vignette(s) built with the 'rmarkdown' package. Please see https://github.com/yihui/knitr/issues/1864 for more information.
E> --- failed re-building ‘bandle-vignette-getting-started.Rmd’
E> 
E> SUMMARY: processing the following file failed:
E>   ‘bandle-vignette-getting-started.Rmd’
E> 
E> Error: Vignette re-building failed.
E> Execution halted

This PR updates the recommended installation command to include vignettes and dependencies (e.g pheatmap required to build vignette).

TomSmithCGAT commented 2 years ago

Ignore this PR. Will be OK when merge with plots branch complete (https://github.com/ococrook/bandle/commit/55e6c9e68b36441188ac1ab692cbaa19a6701e79)