Skip to content
This repository has been archived by the owner on Nov 10, 2024. It is now read-only.

Commit

Permalink
udpate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkearney committed May 16, 2019
1 parent 079cf2c commit f62b79c
Show file tree
Hide file tree
Showing 168 changed files with 7,175 additions and 3,038 deletions.
31 changes: 10 additions & 21 deletions R/premium.R
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ format_from_to_date <- function(x = NULL) {
#' account), which is converted to a bearer token in order to make premium
#' API requests
#'
#' @details
#'
#' @section Developer Account:
#' Users must have an approved developer account and an active/labelled
#' environment to access Twitter's premium APIs. For more information, to check
Expand All @@ -68,26 +66,23 @@ format_from_to_date <- function(x = NULL) {
#' \emph{Note: Bolded operators ending with a colon should be immediately
#' followed by a word or quoted phrase (if appropriate)–e.g.,} \code{lang:en}
#'
#' Matching on Tweet contents by keyword:
#'
#' @section Keyword:
#' \itemize{
#' \item \strong{""} ~~ match exact phrase
#' \item \strong{#} ~~ hashtag
#' \item \strong{@} ~~ at mentions)
#' \item \strong{@@} ~~ at mentions)
#' \item \strong{url:} ~~ found in URL
#' \item \strong{lang:} ~~ language of tweet
#' }
#'
#' accounts of interest:
#'
#' @section Accounts of interest:
#' \itemize{
#' \item \strong{from:} ~~ authored by
#' \item \strong{to:} ~~ sent to
#' \item \strong{retweets_of:} ~~ retweet author
#' }
#'
#' tweet attributes:
#'
#' @section Tweet attributes:
#' \itemize{
#' \item \strong{is:retweet} ~~ only retweets
#' \item \strong{has:mentions} ~~ uses mention(s)
Expand All @@ -99,8 +94,7 @@ format_from_to_date <- function(x = NULL) {
#' \item \strong{is:verified} ~~ from verified accounts
#' }
#'
#' and/or geospatial:
#'
#' @section Geospatial:
#' \itemize{
#' \item \strong{bounding_box:[west_long south_lat east_long north_lat]} ~~ lat/long coordinates box
#' \item \strong{point_radius:[lon lat radius]} ~~ center of search radius
Expand Down Expand Up @@ -163,7 +157,6 @@ search_fullarchive <- function(q, n = 100, fromDate = NULL, toDate = NULL,
#' Search Twitter's '30day' (PREMIUM) API
#'
#' @inheritParams search_fullarchive
#' @details
#'
#' @section Developer Account:
#' Users must have an approved developer account and an active/labelled
Expand All @@ -175,26 +168,23 @@ search_fullarchive <- function(q, n = 100, fromDate = NULL, toDate = NULL,
#' \emph{Note: Bolded operators ending with a colon should be immediately
#' followed by a word or quoted phrase (if appropriate)–e.g.,} \code{lang:en}
#'
#' Matching on Tweet contents by keyword:
#'
#' @section Keyword:
#' \itemize{
#' \item \strong{""} ~~ match exact phrase
#' \item \strong{#} ~~ hashtag
#' \item \strong{@} ~~ at mentions)
#' \item \strong{@@} ~~ at mentions)
#' \item \strong{url:} ~~ found in URL
#' \item \strong{lang:} ~~ language of tweet
#' }
#'
#' accounts of interest:
#'
#' @section Accounts of interest:
#' \itemize{
#' \item \strong{from:} ~~ authored by
#' \item \strong{to:} ~~ sent to
#' \item \strong{retweets_of:} ~~ retweet author
#' }
#'
#' tweet attributes:
#'
#' @section Tweet attributes:
#' \itemize{
#' \item \strong{is:retweet} ~~ only retweets
#' \item \strong{has:mentions} ~~ uses mention(s)
Expand All @@ -206,8 +196,7 @@ search_fullarchive <- function(q, n = 100, fromDate = NULL, toDate = NULL,
#' \item \strong{is:verified} ~~ from verified accounts
#' }
#'
#' and/or geospatial:
#'
#' @section Geospatial:
#' \itemize{
#' \item \strong{bounding_box:[west_long south_lat east_long north_lat]} ~~ lat/long coordinates box
#' \item \strong{point_radius:[lon lat radius]} ~~ center of search radius
Expand Down
1 change: 1 addition & 0 deletions docs/news/index.html

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

176 changes: 176 additions & 0 deletions docs/paper.html

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

12 changes: 12 additions & 0 deletions docs/reference/index.html

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

33 changes: 17 additions & 16 deletions docs/reference/post_tweet.html

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

9 changes: 4 additions & 5 deletions docs/reference/round_time.html

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

Loading

0 comments on commit f62b79c

Please sign in to comment.