Skip to content

Commit

Permalink
Added missing package anchors to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sambtalcott committed Nov 26, 2024
1 parent 39f0e19 commit 6eaaa38
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions R/sp_.R
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ is_site_url <- function(x) {
#' @export
#' @md
#'
#' @seealso [ms_site], [ms_drive]
#' @seealso [Microsoft365R::ms_site], [Microsoft365R::ms_drive]
#'
#' @examplesIf interactive()
#'
Expand Down Expand Up @@ -377,7 +377,7 @@ sp_list_subsites <- function(site = NULL, pattern = NULL) {
#' @details
#' # Details
#' For more information on methods (shown as `$__()` below) see documentation
#' on [ms_drive].
#' on [Microsoft365R::ms_drive].
#' ## Reading Functions
#' * ".csv", ".csv2", ".tsv" are read using the `$load_dataframe()` method,
#' which uses [`readr::read_delim()`].
Expand All @@ -403,7 +403,7 @@ sp_list_subsites <- function(site = NULL, pattern = NULL) {
#' @param type Optional. One of "dataframe" (for delimited files), "xlsx", or "rds". Uses the file extension to determine type if not provided.
#' @param ... Additional arguments passed on to the reading/writing function.
#'
#' @seealso [sp_upload()], [sp_download()]; `$upload_file()`, `$download_file()`, `$save_rdata()`, `$load_rdata()` from [ms_drive]
#' @seealso [sp_upload()], [sp_download()]; `$upload_file()`, `$download_file()`, `$save_rdata()`, `$load_rdata()` from [Microsoft365R::ms_drive]
#'
#' @return `sp_read()` returns an R object as specified by type. `sp_write()`
#' returns x, invisibly
Expand Down Expand Up @@ -555,7 +555,7 @@ sp_write_xlsx <- function(x, path, site, drive, ...) {
#' Sharepoint upload/download
#'
#' `sp_upload()` and `sp_download()` wrap the `$upload_file()` and `$download_file()`
#' methods from the [ms_drive] object. In addition, `sp_upload()` checks for the
#' methods from the [Microsoft365R::ms_drive] object. In addition, `sp_upload()` checks for the
#' existence of the destination folder and will prompt the user to create it if
#' it doesn't exist.
#'
Expand All @@ -567,7 +567,7 @@ sp_write_xlsx <- function(x, path, site, drive, ...) {
#'
#' @md
#'
#' @seealso [sp_read()], [sp_write()]; `$upload_file()` and `$download_file()` from [ms_drive]
#' @seealso [sp_read()], [sp_write()]; `$upload_file()` and `$download_file()` from [Microsoft365R::ms_drive]
#'
#' @return Returns `dest` invisibly
#' @export
Expand Down Expand Up @@ -639,7 +639,7 @@ sp_download <- function(src, dest = basename(src), site = NULL, drive = NULL, ov

#' Create Sharepoint Folder
#'
#' Wrapper around the `$create_folder()` method from [ms_drive]
#' Wrapper around the `$create_folder()` method from [Microsoft365R::ms_drive]
#'
#' @param folder_path Path to the new folder
#' @param site Site identifier. Can be the site name, id, URL, or an ms_site object. If no site identifier is provided, uses the stored default site if it exists.
Expand Down
2 changes: 1 addition & 1 deletion R/theme_tntp_2018.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#' A precise & pristine `ggplot2` theme with opinionated defaults and an emphasis on typography
#'
#' This theme is superseded by [tntp_style()].
#'
Expand Down
2 changes: 1 addition & 1 deletion man/sp_create_folder.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/sp_read.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/sp_site.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/sp_upload.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/theme_tntp_2018.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6eaaa38

Please sign in to comment.