From 4114f158efaac9faa5906618b838a875d53f1aae Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Thu, 19 Dec 2024 14:09:18 -0500 Subject: [PATCH] Update docs --- NAMESPACE | 6 +++++- man/check_git_repo.Rd | 4 +++- man/coursera.Rd | 4 +++- man/get_repo_info.Rd | 3 +-- man/website_to_embed_leanpub.Rd | 2 ++ 5 files changed, 14 insertions(+), 5 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 6b05c19..b87daad 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -16,10 +16,12 @@ export(convert_coursera_quizzes) export(convert_quiz) export(course_path) export(course_to_book_txt) +export(delete_creds) export(extract_meta) export(extract_object_id) export(extract_quiz) export(get_chapters) +export(get_github) export(get_gs_pptx) export(get_image_from_slide) export(get_image_link_from_slide) @@ -41,6 +43,7 @@ export(parse_quiz_df) export(pptx_notes) export(pptx_slide_note_df) export(pptx_slide_text_df) +export(qrmd_files) export(render_without_toc) export(setup_ottr_template) export(unzip_pptx) @@ -58,10 +61,11 @@ importFrom(httr,oauth_app) importFrom(httr,oauth_endpoints) importFrom(jsonlite,fromJSON) importFrom(magrittr,"%>%") -importFrom(openssl,aes_cbc_decrypt) importFrom(readr,write_tsv) importFrom(rprojroot,find_root) importFrom(rprojroot,has_dir) +importFrom(stringr,str_to_title) +importFrom(utils,browseURL) importFrom(utils,download.file) importFrom(utils,installed.packages) importFrom(utils,menu) diff --git a/man/check_git_repo.Rd b/man/check_git_repo.Rd index d2431ed..45db4c7 100644 --- a/man/check_git_repo.Rd +++ b/man/check_git_repo.Rd @@ -34,8 +34,10 @@ output from git ls-remote if return_repo = TRUE. Given a repository name, check with git ls-remote whether the repository exists and return a TRUE/FALSE } \examples{ +\dontrun { +authorize("github") check_git_repo("jhudsl/OTTR_Template") - +} } diff --git a/man/coursera.Rd b/man/coursera.Rd index b960602..2a69c3b 100644 --- a/man/coursera.Rd +++ b/man/coursera.Rd @@ -5,7 +5,7 @@ \title{Create TOC-less course website for use in Coursera or Leanpub} \usage{ render_without_toc( - course_path = ".", + path = ".", output_dir = file.path("docs", "no_toc"), output_yaml = "_output.yml", convert_quizzes = FALSE, @@ -15,6 +15,8 @@ render_without_toc( ) } \arguments{ +\item{path}{path to the bookdown or quarto course repository, must have a `_bookdown.yml` or `_quarto.yml` file} + \item{output_dir}{A folder (existing or not) that the TOC-less Bookdown for Coursera files should be saved. By default is file.path("docs", "coursera")} \item{output_yaml}{A output.yml file to be provided to bookdown. By default is "_output.yml"} diff --git a/man/get_repo_info.Rd b/man/get_repo_info.Rd index 5178bba..50ccf18 100644 --- a/man/get_repo_info.Rd +++ b/man/get_repo_info.Rd @@ -12,8 +12,7 @@ e.g. "jhudsl/OTTR_Template"} \item{token}{If private repositories are to be retrieved, a github personal access token needs to be supplied. If none is supplied, then this will attempt to -grab from a git pat set in the environment with usethis::create_github_token(). -Authorization handled by \link[githubr]{get_git_auth}} +grab from a git pat set in the environment with usethis::create_github_token().} \item{verbose}{TRUE/FALSE do you want more progress messages?} } diff --git a/man/website_to_embed_leanpub.Rd b/man/website_to_embed_leanpub.Rd index 095b5dc..de8a416 100644 --- a/man/website_to_embed_leanpub.Rd +++ b/man/website_to_embed_leanpub.Rd @@ -37,6 +37,8 @@ If no image column supplied, default image used.} \item{base_url}{The base url of where the chapters are published -- the url to provide to the iframe in Leanpub e.g. https://jhudatascience.org/OTTR_Template/coursera} +\item{clean_up}{Should the previous docs and manuscript folder be cleaned up?} + \item{default_img}{A google slide link to the default image to be used for all chapters} \item{output_dir}{output directory to put files. It should likely be