updated documentation

gtonkinhill · May 20, 2019 · 37ba87a · 37ba87a
1 parent b169903
commit 37ba87a
Show file tree

Hide file tree

Showing 8 changed files with 6 additions and 2 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -42,7 +42,9 @@ devtools::install_github("gtonkinhill/fastbaps", build_vignettes = TRUE)
 
 ## Quick Start
 
-Run fastbaps
+Run fastbaps.
+
+**NOTE:** You need to replace the variable `fasta.file.name` with the path to your fasta file. The system.file function is only used in this example vignette.
 
 ```{r, fig.width =8, fig.height=6, fig.align='center'}
 # devtools::install_github("gtonkinhill/fastbaps")

diff --git a/README.md b/README.md
@@ -25,7 +25,9 @@ devtools::install_github("gtonkinhill/fastbaps", build_vignettes = TRUE)
 Quick Start
 -----------
 
-Run fastbaps
+Run fastbaps.
+
+**NOTE:** You need to replace the variable `fasta.file.name` with the path to your fasta file. The system.file function is only used in this example vignette.
 
 ``` r
 # devtools::install_github('gtonkinhill/fastbaps')

diff --git a/inst/vignette-supp/unnamed-chunk-12-1.png b/inst/vignette-supp/unnamed-chunk-12-1.png
diff --git a/inst/vignette-supp/unnamed-chunk-13-1.png b/inst/vignette-supp/unnamed-chunk-13-1.png
diff --git a/inst/vignette-supp/unnamed-chunk-14-1.png b/inst/vignette-supp/unnamed-chunk-14-1.png
diff --git a/inst/vignette-supp/unnamed-chunk-15-1.png b/inst/vignette-supp/unnamed-chunk-15-1.png
diff --git a/inst/vignette-supp/unnamed-chunk-16-1.png b/inst/vignette-supp/unnamed-chunk-16-1.png
diff --git a/inst/vignette-supp/unnamed-chunk-17-1.png b/inst/vignette-supp/unnamed-chunk-17-1.png