Skip to content

Commit

Permalink
add to docs for search_tweets and get_timeline
Browse files Browse the repository at this point in the history
  • Loading branch information
mkearney committed Nov 4, 2018
1 parent 274b335 commit 4681a77
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 17 deletions.
14 changes: 14 additions & 0 deletions R/search_tweets.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@
#' e.g., \code{q = '"data science"'} or escape each internal double
#' quote with a single backslash, e.g., \code{q =
#' "\"data science\""}.
#'
#' Some other useful query tips:
#'
#' \itemize{
#' \item Exclude retweets via \code{"-filter:retweets"}
#' \item Exclude quotes via \code{"-filter:quote"}
#' \item Exclude replies via \code{"-filter:replies"}
#' \item Filter (return only) verified via \code{"filter:verified"}
#' \item Exclude verified via \code{"-filter:verified"}
#' \item Get everything (firehose for free) via \code{"-filter:verified OR filter:verified"}
#' \item Filter (return only) tweets with links to news articles via \code{"filter:news"}
#' \item Filter (return only) tweets with media \code{"filter:media"}
#' }
#'
#' @param n Integer, specifying the total number of desired tweets to
#' return. Defaults to 100. Maximum number of tweets returned from a
#' single token is 18,000. To return more than 18,000 tweets, users
Expand Down
4 changes: 3 additions & 1 deletion R/timeline.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
#'
#' @param user Vector of user names, user IDs, or a mixture of both.
#' @param n Number of tweets to return per timeline. Defaults to 100.
#' Must be of length 1 or equal to length of user.
#' Must be of length 1 or equal to length of user. This number should
#' not exceed 3200 as Twitter limits returns to the most recent 3,200
#' statuses posted or retweeted by each user.
#' @param max_id Character, returns results with an ID less than (that is,
#' older than) or equal to `max_id`.
#' @param home Logical, indicating whether to return a user-timeline
Expand Down
4 changes: 3 additions & 1 deletion man/get_timeline.Rd

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

43 changes: 28 additions & 15 deletions man/search_tweets.Rd

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

0 comments on commit 4681a77

Please sign in to comment.