add comment about yt_outh to all man pages

NEWS.md

@@ -1,5 +1,6 @@
 # version 0.6.0 
 
+* Based on CRAN feedback, add comment about yt_outh to all man pages
 * video_id is returned as part of the list for get_stats, get_video_details
 * handles errors stemming from bad video id for get_stats, get_video_details
 * fixed bug in get_comment that delivers separate results for diff. filters, error handling for bad comment_id, and now comment_id returned as part of df 

R/get_captions.R

@@ -16,6 +16,9 @@
 #'  
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_captions(video_id="yJXTXN4xrI8")
 #' get_captions(id="y3ElXcEME3lSISz6izkWVT5GvxjPu8pA")
 #' }

R/get_channel_stats.R

@@ -14,6 +14,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_channel_stats(channel_id="UChTJTbr5kf3hYazJZO-euHg")
 #' }
 

R/get_comment_threads.R

@@ -26,6 +26,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_comment_threads(filter = c(video_id="N708P-A45D0"))
 #' }
 

R/get_comments.R

@@ -28,6 +28,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_comments(filter = c(comment_id="z13dh13j5rr0wbmzq04cifrhtuypwl4hsdk"))
 #' get_comments(filter = 
 #' c(comment_id="z13dh13j5rr0wbmzq04cifrhtuypwl4hsdk, z13dh13j5rr0wbmzq04cifrhtuypwl4hsdk"))

R/get_playlist_items.R

@@ -18,6 +18,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_playlist_items(filter= c(playlist_id="PLrEnWoR732-CN09YykVof2lxdI3MLOZda"))
 #' }
 

R/get_playlists.R

@@ -18,6 +18,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_playlists(filter=c(channel_id="UChTJTbr5kf3hYazJZO-euHg"))
 #' }
 

R/get_related_videos.R

@@ -16,6 +16,9 @@
 #' @references \url{https://developers.google.com/youtube/v3/docs/search/list}
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_related_videos(video_id="yJXTXN4xrI8")
 #' }
 

R/get_stats.R

@@ -11,6 +11,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_stats(video_id="N708P-A45D0")
 #' }
 

R/get_subscriptions.R

@@ -21,6 +21,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_subscriptions(filter=c(channel_id="UChTJTbr5kf3hYazJZO-euHg"))
 #' }
 

R/get_video_details.R

@@ -14,6 +14,9 @@
 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' get_video_details(video_id="yJXTXN4xrI8")
 #' }
 

R/list_abuse_report_reasons.R

@@ -16,6 +16,9 @@
 #' @references \url{https://developers.google.com/youtube/v3/docs/videoAbuseReportReasons/list}
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_abuse_report_reasons()
 #' list_abuse_report_reasons(part="id")
 #' list_abuse_report_reasons(part="snippet")

R/list_caption_tracks.R

@@ -18,6 +18,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_caption_tracks(video_id="yJXTXN4xrI8")
 #' }
 

R/list_channel_activities.R

@@ -21,6 +21,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_channel_activities(filter = c(channel_id="UCRw8bIz2wMLmfgAgWm903cA"))
 #' list_channel_activities(filter = c(channel_id="UCRw8bIz2wMLmfgAgWm903cA", regionCode="US"))
 #' }

R/list_channel_resources.R

@@ -22,6 +22,9 @@
 #' @examples
 #' 
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_channel_resources(filter = c(channel_id = "UCT5Cx1l4IS3wHkJXNyuj4TA"))
 #' list_channel_resources(filter = c(username = "latenight"), part="id, contentDetails")
 #' list_channel_resources(filter = c(username = "latenight"), part="id, contentDetails", 

R/list_channel_sections.R

@@ -18,6 +18,9 @@
 #' @examples
 #' 
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_channel_sections(c(channel_id="UCRw8bIz2wMLmfgAgWm903cA"))
 #' }
 

R/list_channel_videos.R

@@ -11,6 +11,9 @@
 #' @examples
 #' 
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_channel_videos(channel_id = "UCT5Cx1l4IS3wHkJXNyuj4TA")
 #' list_channel_videos(channel_id = "UCT5Cx1l4IS3wHkJXNyuj4TA", max_results=10)
 #' }

R/list_guidecats.R

@@ -18,6 +18,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_guidecats(c(region_code = "JP"))
 #' }
 

R/list_langs.R

@@ -1,13 +1,19 @@
 #' List Languages That Youtube Currently Supports
 #' 
-#' @return data.frame with 3 columns: hl (two letter abbreviation), name (of the language), etag
 #' @param hl  Language used for text values. Optional. Default is \code{en-US}. For other allowed language codes, see \code{\link{list_langs}}.
 #' @param \dots Additional arguments passed to \code{\link{tuber_GET}}.
 #' 
+#' @return data.frame with 3 columns: hl (two letter abbreviation), name (of the language), etag
+#' 
 #' @export
+#' 
 #' @references \url{https://developers.google.com/youtube/v3/docs/i18nLanguages/list}
+#' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_langs()
 #' }
 

R/list_regions.R

@@ -9,6 +9,9 @@
 #' @references \url{https://developers.google.com/youtube/v3/docs/i18nRegions/list}
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_regions()
 #' }
 

R/list_videocats.R

@@ -14,6 +14,9 @@
 #' 
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_videocats(c(region_code = "JP"))
 #' }
 

R/list_videos.R

@@ -16,6 +16,9 @@
 #' @references \url{https://developers.google.com/youtube/v3/docs/search/list}
 #' @examples
 #' \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' list_videos()
 #' }
 

R/yt_topic_search.R

@@ -8,6 +8,9 @@
 #' @export
 #' @examples
 #'  \dontrun{
+#' 
+#' # Set API token via yt_oauth() first
+#' 
 #' yt_topic_search(topic="Barack Obama")
 #' }