Updated major version

vosonlab · Aug 30, 2022 · fc5cd2d · fc5cd2d
1 parent 2e685aa
commit fc5cd2d
Show file tree

Hide file tree

Showing 20 changed files with 64 additions and 36 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: voson.tcn
 Title: Twitter Conversation Networks and Analysis
-Version: 0.4.4
+Version: 0.5.0
 Description: Collects tweets and metadata for threaded conversations and
     generates networks.
 Type: Package

diff --git a/NEWS.md b/NEWS.md
@@ -1,9 +1,11 @@
-# voson.tcn 0.4.4
+# voson.tcn 0.5.0
 
-## Minor Changes
+## Major Changes
 - Previously each tweet provided to `tcn_threads` was retrieved individually as the initializing tweet, the `conversation_id` extracted and then used as a search filter to collect a single conversation thread. This was a very inefficient process for large numbers of threads as it used one API request per thread, soon reaching the `full-archive` search endpoint 300 request per 15 minute rate-limit (and imposing a ceiling of maximum 300 threads per 15 minutes).
 - Tweets provided to `tcn_threads` are now collected at the start of an operation in batch and unique `conversation_id` extracted from the tweets to do batch thread collection. An `academic` or `full-archive` enabled project has a search query character limit of 1024 characters, and projects limited to the `recent` search endpoint a 512 character limit. A search query for multiple `conversation_id` can be created in the following format: `conversation_id:xxxxxxxxxxxxxxxxxxx OR conversation_id:xxxxxxxxxxxxxxxxxxx OR ...` within the character limit. 
 - The `tcn_threads` function now searches for as many `conversation_id` per request that will fit into the search query character limit, significantly improving the thread collection time. This is approximately 26 ID's per `full-archive` and 13 per `recent` search request. So for example, a maximum of 26 threads can be collected in a single request assuming the sum of tweets from all threads is less than `max_results`. This translates to 7,800 threads per 15 minutes (300 * 26) for the `full-archive` endpoint if each request of 26 threads has less than 500 tweets.
+
+## Minor Changes
 - Set the default `max_results` to again be `500` tweets for `full-archive` searches. This was previously set to `100` tweets, the same as the `max_results` for a `recent` endpoint search because of an issue requesting the `context_annotations` tweet data field (Twitter impose a 100 tweet max for requests that include this field). The `context_annotations` is no longer collected by default but can be included by using the `annotations = TRUE` parameter.
 - Added progress bars and option for verbose output.
 

diff --git a/R/tcn_threads.R b/R/tcn_threads.R
@@ -147,7 +147,9 @@ tcn_threads <-
 
     chunks <- build_chunks(cids, endpoint = endpoint)
 
-    msg(paste0("voson.tcn conversation threads: n=", length(cids), ", min-api-requests=", length(chunks), ", endpoint=", endpoint))
+    msg(paste0("voson.tcn conversation threads: n=", length(cids),
+               ", min-api-requests=", length(chunks),
+               ", endpoint=", endpoint))
 
     if (verbose) {
       pb <- prog_bar(length(chunks), "")

diff --git a/README.Rmd b/README.Rmd
@@ -333,7 +333,7 @@ ggraph(g, layout = layout.auto(g)) +
 
 Plots of an activity network and corresponding actor reply network graph generated from a small Twitter conversation thread.
 
-<img src="https://vosonlab.github.io/voson.tcn/images/network_graphs_plot.png" alt="activity and actor network graphs"/>
+<img src="https://vosonlab.github.io/voson.tcn/images/network_graphs_plot.png" alt="activity and actor network graphs" width="90%"/>
 
 ## Code of Conduct
 

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [![CRAN_Monthly](https://cranlogs.r-pkg.org/badges/voson.tcn)](https://CRAN.R-project.org/package=voson.tcn)
 [![CRAN_Total](https://cranlogs.r-pkg.org/badges/grand-total/voson.tcn)](https://CRAN.R-project.org/package=voson.tcn)
 [![Github_Release](https://img.shields.io/github/release-pre/vosonlab/voson.tcn.svg?logo=github)](https://github.com/vosonlab/voson.tcn/releases)
-[![Github_Dev](https://img.shields.io/static/v1?label=dev&message=v0.4.3&logo=github)](https://github.com/vosonlab/voson.tcn)
+[![Github_Dev](https://img.shields.io/static/v1?label=dev&message=v0.5.0&logo=github)](https://github.com/vosonlab/voson.tcn)
 [![Last_Commit](https://img.shields.io/github/last-commit/vosonlab/voson.tcn.svg?&logo=github)](https://github.com/vosonlab/voson.tcn/commits/main)
 [![Build_Status](https://github.com/vosonlab/voson.tcn/workflows/R-CMD-check/badge.svg)](https://github.com/vosonlab/voson.tcn/actions)
 
@@ -32,7 +32,7 @@ Install the most recent release tag via GitHub:
 
 ``` r
 install.packages(
-  "https://github.com/vosonlab/voson.tcn/releases/download/v0.4.1/voson.tcn-0.4.1.tar.gz",
+  "https://github.com/vosonlab/voson.tcn/releases/download/v0.5.0/voson.tcn-0.5.0.tar.gz",
   repo = NULL, type = "source")
 ```
 
@@ -388,7 +388,7 @@ ggraph(g, layout = layout.auto(g)) +
 Plots of an activity network and corresponding actor reply network graph
 generated from a small Twitter conversation thread.
 
-<img src="https://vosonlab.github.io/voson.tcn/images/network_graphs_plot.png" alt="activity and actor network graphs"/>
+<img src="https://vosonlab.github.io/voson.tcn/images/network_graphs_plot.png" alt="activity and actor network graphs" width="90%"/>
 
 ## Code of Conduct
 

diff --git a/cran-comments.md b/cran-comments.md
@@ -2,7 +2,7 @@
 * local MacOS X, R 4.2.0
 * local Windows 10, R 4.2.1
 * Winbuilder (R-release, R-oldrelease)
-* R-Devel r82676 Windows (Winbuilder)
+* R-Devel r82766 Windows (Winbuilder)
 
 ## R CMD check results
 0 errors | 0 warnings | 0 notes
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: '2.18'
 pkgdown: 2.0.6
 pkgdown_sha: ~
 articles: {}
-last_built: 2022-08-20T05:49Z
+last_built: 2022-08-30T13:19Z
 urls:
   reference: https://vosonlab.github.io/voson.tcn/reference
   article: https://vosonlab.github.io/voson.tcn/articles

diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/tcn_counts.html b/docs/reference/tcn_counts.html
diff --git a/docs/reference/tcn_network.html b/docs/reference/tcn_network.html
diff --git a/docs/reference/tcn_threads.html b/docs/reference/tcn_threads.html