diff --git a/.Rbuildignore b/.Rbuildignore index b1cb5af..a90073f 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,6 +1,6 @@ -^.*/.Rproj$ +^.*\.Rproj$ ^README.Rmd$ -^/.Rproj/.user$ +^\.Rproj\.user$ ^.github$ ^.httr-oauth$ ^dev$ @@ -11,9 +11,12 @@ ^appveyor.yml$ ^cran-comments.md$ ^tests/testthat/yt_key.enc$ -^/.httr-oauth$ -^_pkgdown/.yml$ +^\.httr-oauth$ +^_pkgdown\.yml$ ^revdep$ .lintr ^data-raw$ ^emoji_vignette$ +^.*\.Rproj$ +^\.Rproj\.user$ +_pkgdown.yml diff --git a/DESCRIPTION b/DESCRIPTION index 86923f2..5ced0af 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -30,6 +30,5 @@ Suggests: xml2, lintr, hms -RoxygenNote: 6.1.1 +RoxygenNote: 7.1.0 Encoding: UTF-8 - diff --git a/R/get_playlist_items.R b/R/get_playlist_items.R index 7d37729..378cc96 100644 --- a/R/get_playlist_items.R +++ b/R/get_playlist_items.R @@ -82,5 +82,6 @@ get_playlist_items <- function (filter = NULL, part = "contentDetails", recursive = FALSE), as.data.frame, stringsAsFactors = FALSE) ) - } res + } + res } diff --git a/R/tuber.R b/R/tuber.R index 490e528..8b2f2bc 100644 --- a/R/tuber.R +++ b/R/tuber.R @@ -1,4 +1,7 @@ -#' \pkg{tuber} provides access to the YouTube API V3. +#' @title \pkg{tuber} provides access to the YouTube API V3. +#' +#' @description \pkg{tuber} provides access to the YouTube API V3 via +#' RESTful calls. #' #' @name tuber #' @importFrom httr GET POST DELETE authenticate config stop_for_status upload_file content oauth_endpoints oauth_app oauth2.0_token diff --git a/man/get_captions.Rd b/man/get_captions.Rd index cceb29f..548daa1 100644 --- a/man/get_captions.Rd +++ b/man/get_captions.Rd @@ -4,8 +4,7 @@ \alias{get_captions} \title{Get Particular Caption Track} \usage{ -get_captions(id = NULL, lang = "en", format = "sbv", as_raw = TRUE, - ...) +get_captions(id = NULL, lang = "en", format = "sbv", as_raw = TRUE, ...) } \arguments{ \item{id}{String. Required. id of the caption track that is being retrieved} diff --git a/man/get_comment_threads.Rd b/man/get_comment_threads.Rd index 89532ae..3485fdf 100644 --- a/man/get_comment_threads.Rd +++ b/man/get_comment_threads.Rd @@ -4,9 +4,15 @@ \alias{get_comment_threads} \title{Get Comments Threads} \usage{ -get_comment_threads(filter = NULL, part = "snippet", - text_format = "html", simplify = TRUE, max_results = 100, - page_token = NULL, ...) +get_comment_threads( + filter = NULL, + part = "snippet", + text_format = "html", + simplify = TRUE, + max_results = 100, + page_token = NULL, + ... +) } \arguments{ \item{filter}{string; Required. diff --git a/man/get_comments.Rd b/man/get_comments.Rd index 01c2fee..315526d 100644 --- a/man/get_comments.Rd +++ b/man/get_comments.Rd @@ -4,8 +4,15 @@ \alias{get_comments} \title{Get Comments} \usage{ -get_comments(filter = NULL, part = "snippet", max_results = 100, - text_format = "html", page_token = NULL, simplify = TRUE, ...) +get_comments( + filter = NULL, + part = "snippet", + max_results = 100, + text_format = "html", + page_token = NULL, + simplify = TRUE, + ... +) } \arguments{ \item{filter}{string; Required. diff --git a/man/get_playlist_items.Rd b/man/get_playlist_items.Rd index 0569f7b..31f36d9 100644 --- a/man/get_playlist_items.Rd +++ b/man/get_playlist_items.Rd @@ -4,9 +4,15 @@ \alias{get_playlist_items} \title{Get Playlist Items} \usage{ -get_playlist_items(filter = NULL, part = "contentDetails", - max_results = 50, video_id = NULL, page_token = NULL, - simplify = TRUE, ...) +get_playlist_items( + filter = NULL, + part = "contentDetails", + max_results = 50, + video_id = NULL, + page_token = NULL, + simplify = TRUE, + ... +) } \arguments{ \item{filter}{string; Required. diff --git a/man/get_playlists.Rd b/man/get_playlists.Rd index 6b46aec..8bd8873 100644 --- a/man/get_playlists.Rd +++ b/man/get_playlists.Rd @@ -4,8 +4,15 @@ \alias{get_playlists} \title{Get Playlists} \usage{ -get_playlists(filter = NULL, part = "snippet", max_results = 50, - hl = NULL, page_token = NULL, simplify = TRUE, ...) +get_playlists( + filter = NULL, + part = "snippet", + max_results = 50, + hl = NULL, + page_token = NULL, + simplify = TRUE, + ... +) } \arguments{ \item{filter}{string; Required. diff --git a/man/get_related_videos.Rd b/man/get_related_videos.Rd index 22e3adc..8c26c47 100644 --- a/man/get_related_videos.Rd +++ b/man/get_related_videos.Rd @@ -4,8 +4,12 @@ \alias{get_related_videos} \title{Get Related Videos} \usage{ -get_related_videos(video_id = NULL, max_results = 50, - safe_search = "none", ...) +get_related_videos( + video_id = NULL, + max_results = 50, + safe_search = "none", + ... +) } \arguments{ \item{video_id}{Character. Required. No default.} diff --git a/man/get_subscriptions.Rd b/man/get_subscriptions.Rd index 0662531..5c6d185 100644 --- a/man/get_subscriptions.Rd +++ b/man/get_subscriptions.Rd @@ -4,9 +4,15 @@ \alias{get_subscriptions} \title{Get Subscriptions} \usage{ -get_subscriptions(filter = NULL, part = "contentDetails", - max_results = 50, for_channel_id = NULL, order = NULL, - page_token = NULL, ...) +get_subscriptions( + filter = NULL, + part = "contentDetails", + max_results = 50, + for_channel_id = NULL, + order = NULL, + page_token = NULL, + ... +) } \arguments{ \item{filter}{string; Required. diff --git a/man/list_caption_tracks.Rd b/man/list_caption_tracks.Rd index 9600378..ca264c8 100644 --- a/man/list_caption_tracks.Rd +++ b/man/list_caption_tracks.Rd @@ -4,8 +4,14 @@ \alias{list_caption_tracks} \title{List Captions of a Video} \usage{ -list_caption_tracks(part = "snippet", video_id = NULL, lang = "en", - id = NULL, simplify = TRUE, ...) +list_caption_tracks( + part = "snippet", + video_id = NULL, + lang = "en", + id = NULL, + simplify = TRUE, + ... +) } \arguments{ \item{part}{Caption resource requested. Required. Comma separated list of one or more of the diff --git a/man/list_channel_activities.Rd b/man/list_channel_activities.Rd index b818612..8d284ee 100644 --- a/man/list_channel_activities.Rd +++ b/man/list_channel_activities.Rd @@ -4,9 +4,17 @@ \alias{list_channel_activities} \title{List Channel Activity} \usage{ -list_channel_activities(filter = NULL, part = "snippet", - max_results = 50, page_token = NULL, published_after = NULL, - published_before = NULL, region_code = NULL, simplify = TRUE, ...) +list_channel_activities( + filter = NULL, + part = "snippet", + max_results = 50, + page_token = NULL, + published_after = NULL, + published_before = NULL, + region_code = NULL, + simplify = TRUE, + ... +) } \arguments{ \item{filter}{string; Required. diff --git a/man/list_channel_resources.Rd b/man/list_channel_resources.Rd index 6ab19e2..6980554 100644 --- a/man/list_channel_resources.Rd +++ b/man/list_channel_resources.Rd @@ -4,8 +4,14 @@ \alias{list_channel_resources} \title{Returns List of Requested Channel Resources} \usage{ -list_channel_resources(filter = NULL, part = "contentDetails", - max_results = 50, page_token = NULL, hl = "en-US", ...) +list_channel_resources( + filter = NULL, + part = "contentDetails", + max_results = 50, + page_token = NULL, + hl = "en-US", + ... +) } \arguments{ \item{filter}{string; Required. diff --git a/man/list_channel_sections.Rd b/man/list_channel_sections.Rd index ad112b5..5d343c4 100644 --- a/man/list_channel_sections.Rd +++ b/man/list_channel_sections.Rd @@ -4,8 +4,7 @@ \alias{list_channel_sections} \title{List Channel Sections} \usage{ -list_channel_sections(filter = NULL, part = "snippet", hl = NULL, - ...) +list_channel_sections(filter = NULL, part = "snippet", hl = NULL, ...) } \arguments{ \item{filter}{string; Required. diff --git a/man/list_channel_videos.Rd b/man/list_channel_videos.Rd index e74409c..3a664fa 100644 --- a/man/list_channel_videos.Rd +++ b/man/list_channel_videos.Rd @@ -4,8 +4,13 @@ \alias{list_channel_videos} \title{Returns List of Requested Channel Videos} \usage{ -list_channel_videos(channel_id = NULL, max_results = 50, - page_token = NULL, hl = "en-US", ...) +list_channel_videos( + channel_id = NULL, + max_results = 50, + page_token = NULL, + hl = "en-US", + ... +) } \arguments{ \item{channel_id}{String. ID of the channel. Required.} diff --git a/man/list_videos.Rd b/man/list_videos.Rd index 90f9110..a96b197 100644 --- a/man/list_videos.Rd +++ b/man/list_videos.Rd @@ -4,9 +4,15 @@ \alias{list_videos} \title{List (Most Popular) Videos} \usage{ -list_videos(part = "contentDetails", max_results = 50, - page_token = NULL, hl = NULL, region_code = NULL, - video_category_id = NULL, ...) +list_videos( + part = "contentDetails", + max_results = 50, + page_token = NULL, + hl = NULL, + region_code = NULL, + video_category_id = NULL, + ... +) } \arguments{ \item{part}{Required. Comma separated string including one or more of the following: \code{contentDetails, diff --git a/man/tuber.Rd b/man/tuber.Rd index aeebfc4..42f41be 100644 --- a/man/tuber.Rd +++ b/man/tuber.Rd @@ -3,8 +3,8 @@ \docType{package} \name{tuber} \alias{tuber} -\alias{tuber-package} \title{\pkg{tuber} provides access to the YouTube API V3.} \description{ -\pkg{tuber} provides access to the YouTube API V3. +\pkg{tuber} provides access to the YouTube API V3 via +RESTful calls. } diff --git a/man/upload_caption.Rd b/man/upload_caption.Rd index 97ad062..36ae2ee 100644 --- a/man/upload_caption.Rd +++ b/man/upload_caption.Rd @@ -4,8 +4,16 @@ \alias{upload_caption} \title{Upload Video Caption to Youtube} \usage{ -upload_caption(file, video_id, language = "en-US", caption_name, - is_draft = FALSE, query = NULL, open_url = FALSE, ...) +upload_caption( + file, + video_id, + language = "en-US", + caption_name, + is_draft = FALSE, + query = NULL, + open_url = FALSE, + ... +) } \arguments{ \item{file}{Filename of the caption, probably `.srt`} diff --git a/man/upload_video.Rd b/man/upload_video.Rd index bafb327..2138b1a 100644 --- a/man/upload_video.Rd +++ b/man/upload_video.Rd @@ -4,8 +4,14 @@ \alias{upload_video} \title{Upload Video to Youtube} \usage{ -upload_video(file, snippet = NULL, status = list(privacyStatus = - "public"), query = NULL, open_url = FALSE, ...) +upload_video( + file, + snippet = NULL, + status = list(privacyStatus = "public"), + query = NULL, + open_url = FALSE, + ... +) } \arguments{ \item{file}{Filename of the video locally} diff --git a/man/yt_oauth.Rd b/man/yt_oauth.Rd index fad6429..2853d04 100644 --- a/man/yt_oauth.Rd +++ b/man/yt_oauth.Rd @@ -4,8 +4,13 @@ \alias{yt_oauth} \title{Set up Authorization} \usage{ -yt_oauth(app_id = NULL, app_secret = NULL, scope = "ssl", - token = ".httr-oauth", ...) +yt_oauth( + app_id = NULL, + app_secret = NULL, + scope = "ssl", + token = ".httr-oauth", + ... +) } \arguments{ \item{app_id}{client id; required; no default} diff --git a/man/yt_search.Rd b/man/yt_search.Rd index 16cf7a2..e959f90 100644 --- a/man/yt_search.Rd +++ b/man/yt_search.Rd @@ -4,13 +4,27 @@ \alias{yt_search} \title{Search YouTube} \usage{ -yt_search(term = NULL, max_results = 50, channel_id = NULL, - channel_type = NULL, type = "video", event_type = NULL, - location = NULL, location_radius = NULL, published_after = NULL, - published_before = NULL, video_definition = "any", - video_caption = "any", video_license = "any", - video_syndicated = "any", video_type = "any", simplify = TRUE, - get_all = TRUE, page_token = NULL, ...) +yt_search( + term = NULL, + max_results = 50, + channel_id = NULL, + channel_type = NULL, + type = "video", + event_type = NULL, + location = NULL, + location_radius = NULL, + published_after = NULL, + published_before = NULL, + video_definition = "any", + video_caption = "any", + video_license = "any", + video_syndicated = "any", + video_type = "any", + simplify = TRUE, + get_all = TRUE, + page_token = NULL, + ... +) } \arguments{ \item{term}{Character. Search term; required; no default