Merge pull request #57 from cjbarrie/barrie-branch

Fix documentation descriptions

R/build_queryv2.R

@@ -2,7 +2,7 @@
 #' 
 #' Build tweet query according to targeted parameters, can then be input to main \code{\link{get_all_tweets}} function as query parameter.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param is_retweet If `TRUE`, only retweets will be returned; if `FALSE` retweets will not be returned
 #' @param is_reply If `TRUE`, only reply tweets will be returned
 #' @param is_quote If `TRUE`, only quote tweets will be returned

R/get_all_tweetsv2.R

@@ -5,7 +5,7 @@
 #' User-level data is stored as a series of JSONs beginning "users_". If a filename is supplied, this function will 
 #' save the result as a RDS file, otherwise, it will return the results as a data.frame.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date
 #' @param bearer_token string, bearer token

R/get_bbox_tweetsv2.R

@@ -7,7 +7,7 @@
 #' save the result as a RDS file, otherwise, it will return the results as a data.frame.
 #' Note: width and height of the bounding box must be less than 25mi.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param bbox numeric, a vector of four bounding box coordinates from west longitude to north latitude
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date

R/get_country_tweetsv2.R

@@ -6,7 +6,7 @@
 #' JSONs beginning "users_". If a filename is supplied, this function will 
 #' save the result as a RDS file, otherwise, it will return the results as a data.frame.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param country, string, name of country as ISO alpha-2 code e.g. "GB"
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date

R/get_geo_tweetsv2.R

@@ -8,7 +8,7 @@
 #' path as a series of JSONs beginning "data_"; User-level data is stored as a series of JSONs beginning "users_". 
 #' If a filename is supplied, this function will save the result as a RDS file, otherwise, it will return the results as a dataframe.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date
 #' @param bearer_token string, bearer token

R/get_image_tweetsv2.R

@@ -6,7 +6,7 @@
 #' of JSONs beginning "users_". If a filename is supplied, this function will save the result as a RDS file, 
 #' otherwise, it will return the results as a dataframe.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date
 #' @param bearer_token string, bearer token

R/get_lang_tweetsv2.R

@@ -6,7 +6,7 @@
 #' JSONs beginning "users_". If a filename is supplied, this function will 
 #' save the result as a RDS file, otherwise, it will return the results as a data.frame.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param lang, string, a single BCP 47 language identifier e.g. "fr"
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date

R/get_media_tweetsv2.R

@@ -6,7 +6,7 @@
 #' series of JSONs beginning "users_". If a filename is supplied, this function will save the result 
 #' as a RDS file, otherwise, it will return the results as a dataframe.
 #' 
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date
 #' @param bearer_token string, bearer token

R/get_mentions_tweetsv2.R

@@ -6,7 +6,7 @@
 #' JSONs beginning "users_". If a filename is supplied, this function will save the result as a RDS file, otherwise, 
 #' it will return the results as a dataframe.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date
 #' @param bearer_token string, bearer token

R/get_place_tweetsv2.R

@@ -6,7 +6,7 @@
 #' JSONs beginning "users_". If a filename is supplied, this function will 
 #' save the result as a RDS file, otherwise, it will return the results as a data.frame.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param place, string, name of place e.g. "new york city"
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date

R/get_radius_tweetsv2.R

@@ -7,7 +7,7 @@
 #' save the result as a RDS file, otherwise, it will return the results as a data.frame.
 #' Note: radius must be less than 25mi.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param radius numeric, a vector of two point coordinates latitude, longitude, and point radius distance (in miles)
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date

R/get_video_tweetsv2.R

@@ -7,7 +7,7 @@
 #' as a series of JSONs beginning "users_". If a filename is supplied, this function will save the 
 #' result as a RDS file, otherwise, it will return the results as a dataframe.
 #'
-#' @param query string, search query
+#' @param query string or character vector, search query or queries
 #' @param start_tweets string, starting date
 #' @param end_tweets  string, ending date
 #' @param bearer_token string, bearer token