Update docs

NAMESPACE

@@ -11,6 +11,8 @@ export(check_quiz)
 export(check_quiz_attributes)
 export(check_quiz_question_attributes)
 export(check_quizzes)
+export(check_spelling)
+export(check_urls)
 export(clean_up)
 export(convert_coursera_quizzes)
 export(convert_quiz)
@@ -30,6 +32,7 @@ export(get_pages_url)
 export(get_repo_info)
 export(get_slide_id)
 export(get_slide_page)
+export(get_urls)
 export(good_quiz_path)
 export(gs_id_from_slide)
 export(gs_png_download)
@@ -46,10 +49,12 @@ export(pptx_slide_text_df)
 export(qrmd_files)
 export(render_without_toc)
 export(setup_ottr_template)
+export(test_url)
 export(unzip_pptx)
 export(website_to_embed_leanpub)
 export(xml_notes)
 import(dplyr)
+import(stringr)
 importFrom(gitcreds,gitcreds_get)
 importFrom(httr,GET)
 importFrom(httr,accept_json)
@@ -64,7 +69,13 @@ importFrom(magrittr,"%>%")
 importFrom(readr,write_tsv)
 importFrom(rprojroot,find_root)
 importFrom(rprojroot,has_dir)
+importFrom(rvest,html_attr)
+importFrom(rvest,html_nodes)
+importFrom(rvest,read_html)
+importFrom(spelling,spell_check_files)
 importFrom(stringr,str_to_title)
+importFrom(tidyr,separate)
+importFrom(tidyr,unnest)
 importFrom(utils,browseURL)
 importFrom(utils,download.file)
 importFrom(utils,installed.packages)

R/spell_check.R

@@ -12,7 +12,11 @@
 #' @return A file will be saved that lists the broken URLs will be saved to the specified output_dir.
 #' @export
 #'
-#' @importFrom magrittr
+#' @importFrom magrittr %>%
+#' @importFrom spelling spell_check_files
+#' @importFrom rprojroot find_root has_dir
+#' @importFrom tidyr unnest separate
+#' @importFrom readr write_tsv
 #'
 #' @examples
 #'

R/url_check.R

@@ -12,7 +12,10 @@
 #' @return A file will be saved that lists the broken URLs will be saved to the specified output_dir.
 #' @export
 #'
-#' @importFrom magrittr
+#' @importFrom magrittr %>%
+#' @importFrom rprojroot find_root has_dir
+#' @importFrom tidyr unnest separate
+#' @importFrom readr write_tsv
 #'
 #' @examples
 #'
@@ -102,7 +105,18 @@ check_urls <- function(path = ".",
 #' @return a logical TRUE/FALSE for whether the URL is legitimate.
 #' @export
 #'
-#' @importFrom magrittr
+#' @importFrom magrittr %>%
+#' @importFrom httr GET
+#'
+#' @examples /dontrun {
+#'
+#' # This should print out "failed"
+#' test_url("https://notawebsiteaaaaaaa.com")
+#'
+#'
+#' # This should print out "success"
+#' test_url("https://github.com")
+#' }
 #'
 test_url <- function(url, ignore_urls = "") {
   if (url %in% ignore_urls) {
@@ -134,7 +148,16 @@ test_url <- function(url, ignore_urls = "") {
 #' @return a data.frame of all the URLs identified in the given rmd/qmd/md file
 #' @export
 #'
-#' @importFrom magrittr
+#' @importFrom magrittr %>%
+#' @importFrom rvest html_nodes read_html html_attr
+#' @import stringr
+#'
+#' @examples
+#'
+#' # Add in a URL error
+#  writeLines("A URL error: https://notawebsiteaaaaaaa.com", "url_test_error.md")
+#'
+#' get_urls("url_test_error.md")
 #'
 get_urls <- function(file, ignore_urls = "") {
   message(paste("##### Testing URLs from file:", file))