io campaign metadata, as_tweet_network()

Author: knapply

.Rbuildignore

@@ -18,3 +18,5 @@
 ^test\.graphml$
 ^playground$
 ^\.github$
+^io-campaigns-twitter$
+^playground$

.gitignore

@@ -9,3 +9,4 @@ src-i386
 src-x64
 test.graphml
 playground
+io-campaigns-twitter

DESCRIPTION

@@ -26,7 +26,8 @@ Imports:
     jsonify,
     Rcpp,
     stringi,
-    magrittr
+    magrittr,
+    utils
 Suggests:
     covr,
     geojsonsf,
@@ -35,13 +36,14 @@ Suggests:
     knitr,
     future,
     future.apply,
+    network,
     openxlsx,
     rtweet,
     sf,
     testthat (>= 2.1.0),
-    tibble,
-    utils
+    tibble
 Remotes: 
+    knapply/network,
     SymbolixAU/jsonify,
     ycphs/openxlsx
 URL: https://github.com/knapply/tweetio, https://knapply.github.io/tweetio

NAMESPACE

@@ -1,16 +1,23 @@
 # Generated by roxygen2: do not edit by hand
 
-S3method(as_igraph,data.frame)
-S3method(as_igraph,proto_net)
+S3method(as_tweet_igraph,data.frame)
+S3method(as_tweet_igraph,proto_net)
+S3method(as_tweet_network,data.frame)
+S3method(as_tweet_network,proto_net)
 export("%>%")
 export(as_igraph)
 export(as_proto_net)
+export(as_tweet_igraph)
+export(as_tweet_network)
 export(as_tweet_sf)
 export(example_tweet_file)
 export(extract_statuses)
 export(extract_users)
 export(read_tweets)
 export(read_tweets_bulk)
+export(tweetio_as_tibble)
+export(tweetio_options)
+export(tweetio_verbose)
 export(write_graphml)
 export(write_tweet_csv)
 export(write_tweet_excel)
@@ -22,7 +29,6 @@ importFrom(data.table,as.data.table)
 importFrom(data.table,copy)
 importFrom(data.table,data.table)
 importFrom(data.table,fifelse)
-importFrom(data.table,fread)
 importFrom(data.table,fwrite)
 importFrom(data.table,is.data.table)
 importFrom(data.table,rbindlist)

R/geo.R

@@ -47,7 +47,7 @@ as_tweet_sf <- function(tweet_df,
                         geom_col = c("bbox_coords", "quoted_bbox_coords",
                                      "retweet_bbox_coords",
                                      "ist_complex_value",  "all"), 
-                        as_tibble = getOption("tweetio.as_tibble", FALSE),
+                        as_tibble = tweetio_as_tibble(),
                         .geometry = NULL,
                         ...) {
   # silence R CMD Check NOTE

R/igraph.R

@@ -20,31 +20,44 @@
 #' @param x Tweet data frame or `proto_net`.
 #' @param ... Arguments passed to `as_proto_net()`.
 #' 
+#' @seealso [as_proto_net()], [as_tweet_network()]
+#' 
 #' @template author-bk
 #' 
 #' @examples 
 #' path_to_tweet_file <- example_tweet_file()
 #' tweet_df <- read_tweets(path_to_tweet_file)
 #' 
 #' tweet_df %>% 
-#'   as_igraph()
+#'   as_tweet_igraph()
 #'   
 #' tweet_df %>% 
 #'   as_proto_net() %>% 
-#'   as_igraph()
+#'   as_tweet_igraph()
 #' 
+#' tweet_df %>% 
+#'   as_tweet_igraph(all_status_data = TRUE)
+#'   
+#' tweet_df %>% 
+#'   as_tweet_igraph(all_user_data = TRUE)
+#'
 #' @export
-as_igraph <- function(x, ...) {
-  UseMethod("as_igraph")
+as_tweet_igraph <- function(x, ...) {
+  UseMethod("as_tweet_igraph")
 }
 
+# TODO deprecate `as_igraph()` in favor of `as_tweet_igraph()`
+#' @rdname as_tweet_igraph
+#' 
+#' @export
+as_igraph <- as_tweet_igraph 
 
-#' @rdname as_igraph
+#' @rdname as_tweet_igraph
 #' 
 #' @importFrom data.table %chin%
 #' 
 #' @export
-as_igraph.proto_net <- function(x, ...) {
+as_tweet_igraph.proto_net <- function(x, ...) {
   if (!requireNamespace("igraph", quietly = TRUE)) {
     stop("{igraph} package is required for this funcitonality.", call. = FALSE)
   }
@@ -58,9 +71,7 @@ as_igraph.proto_net <- function(x, ...) {
     igraph::make_empty_graph(n = nrow(x$nodes)),
     el
   )
-  
-  # x$edges[, -(1:2L)]
-  
+
   igraph::edge_attr(out) <- as.list(x$edges[, -(1L:2L)])
   igraph::vertex_attr(out) <- as.list(x$nodes)
 
@@ -74,10 +85,10 @@ as_igraph.proto_net <- function(x, ...) {
 }
 
 
-#' @rdname as_igraph
+#' @rdname as_tweet_igraph
 #' 
 #' @export
-as_igraph.data.frame <- function(x, ...) {
-  as_igraph(as_proto_net(x, ...))
+as_tweet_igraph.data.frame <- function(x, ...) {
+  as_tweet_igraph(as_proto_net(x, ...))
 }