update run_example docs

R/run_example.R

@@ -1,10 +1,9 @@
-#' Example Function
-#'
-#' This function runs a shiny example showcasing different parts of the package.
+#' Run examples
 #'
+#' This function runs an example R Shiny app showcasing different parts of the package.
 #' Code for the app can be found in the inst/example_app folder in the source code.
 #'
-#' @return a shiny app with examples in
+#' @return runs an R Shiny app with examples in
 #' @keywords example
 #' @export
 #' @examples

README.md

@@ -47,7 +47,7 @@ This package is also released with a [Contributor Code of Conduct](.github/CODE_
 
 ### Available components
 
-The package contains an example dashboard you can run yourself, showcasing available components
+The package contains an example app you can run yourself, showcasing available components. The code for the example app is in the `inst/example_app/` folder. Though you can easily run the app from the console using:
 
 ```r
 shinyGovstyle::run_example()

inst/example_app/app.R

@@ -105,7 +105,7 @@ shiny::shinyApp(
 
         shiny::tags$br(),
         shiny::markdown(
-          "If running locally, run ```View(run_example)``` in console to see the code for this app. Otherwise, you can see the <a href='https://github.com/dfe-analytical-services/shinyGovstyle/blob/master/R/run_example.R/'>latest version of the code on GitHub</a>."
+          "You can see the latest version of the <a href='https://github.com/dfe-analytical-services/shinyGovstyle/blob/master/R/run_example.R/'>source code for this app on GitHub</a>."
         ),
 
         # Set up a nav panel so everything not on single page