Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bryn-g committed Aug 16, 2022
1 parent 23b14d4 commit b0af46b
Show file tree
Hide file tree
Showing 69 changed files with 780 additions and 781 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Package: vosonSML
Version: 0.32.6
Version: 0.32.7
Title: Collecting Social Media Data and Generating Networks for Analysis
Description: A suite of easy to use functions for collecting social media
data and generating networks for analysis. Supports Twitter, Youtube,
data and generating networks for analysis. Supports Twitter, YouTube,
Reddit and web site data sources.
Type: Package
Imports:
Expand Down
7 changes: 5 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# vosonSML 0.32.6
# vosonSML 0.32.7

## Major Changes
- Re-wrote and modified `vosonSML` `Twitter` functions to support major changes made in `rtweet` release version 1.0.2.
- Added an `endpoint` parameter to the `Twitter` `Collect` function. It is set to `search` by default, which is the
usual collect behaviour, but can also now be set to `timeline` to collect user timelines instead. See
`Collect.timeline.twitter()` for parameters.
- Changed output message system. `vosonSML` functions are now silent by default. Using the `verbose` parameter will
again print function output.
- Changed output messages to use the `message()` function instead of the `cat()` function by default. Setting the global
Expand All @@ -22,7 +25,7 @@
for all users in the network.
- Twitter data collection now returns a named list of two dataframes containing `tweets` and `users`.
- Removed the `ImportData` function and replaced it with `ImportRtweet()` for `rtweet` version 1.0 format data.
- Added `Merge()` and `MergeFiles()` functions to support the merging of collected data from seperate operations. These
- Added `Merge()` and `MergeFiles()` functions to support the merging of collected data from separate operations. These
functions support input of multiple Collect objects or `.RDS` files, automatically detect the datasource type and
support the `writeToFile` parameter for file output of merged data.

Expand Down
2 changes: 1 addition & 1 deletion R/Authenticate.twitter.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#' method for this package and data collection.
#'
#' The twitter OAuth process is described here:
#' \url{https://developer.twitter.com/en/docs/basics/authentication/overview/oauth}.
#' \url{https://developer.twitter.com/en/docs/authentication/overview}.
#'
#' @note \pkg{vosonSML} uses the \pkg{rtweet} package for twitter data collection and also gratefully acknowledges the
#' techniques and code written by its authors reproduced in this package for creating twitter API access tokens.
Expand Down
2 changes: 1 addition & 1 deletion R/utils_youtube.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ get_yt_video_ids <- function(x) {
url_regex_2 <- paste0("^(?:https://)?(?:www\\.)?youtube\\.com/watch\\?v=(", id_regex, ")?/{0,1}$")
url_regex_3 <- paste0("^(?:https://)?(?:www\\.)?youtube\\.com/shorts/(", id_regex, ")?/{0,1}$")

x <- stringr::str_remove(x, "t=[0-9]+?s$")
x <- stringr::str_remove(x, "&t=[0-9]+?s$")

y <- stringr::str_match(
as.character(x),
Expand Down
3 changes: 0 additions & 3 deletions R/wrappers.R
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,6 @@ auth_twitter_dev <-
#' developer). The authentication object with token produced from this method allows the user to access the API within
#' their own user-context and rate-limits.
#'
#' The twitter OAuth process is described here:
#' \url{https://developer.twitter.com/en/docs/basics/authentication/overview/oauth}.
#'
#' @note \pkg{vosonSML} uses the \pkg{rtweet} package for twitter data collection and also gratefully acknowledges the
#' techniques and code written by its authors reproduced in this package for creating twitter API access tokens.
#'
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ library(vosonSML)
The `vosonSML` R package is a suite of easy to use functions for collecting and generating different types of networks
from social media data. The package supports the collection of data from `twitter`, `youtube` and `reddit`, as well as
`hyperlinks` from web sites. Networks in the form of node and edge lists can be generated from collected data,
supplemented with additional metadata and used to create graphs for Social Network Analysis.
supplemented with additional metadata, and used to create graphs for Social Network Analysis.

## Installation Options

Expand Down
Loading

0 comments on commit b0af46b

Please sign in to comment.