Interface for collection and interactive analysis of social networks

Description

VOSONDash provides functions and an interface in the form of an interactive R Shiny web application for the visualisation and analysis of network data. The app has sections for visualising and manipulating network graphs, performing text analysis, and displaying network metrics. It also has an interface for the collection of social network data using the vosonSML R package.

Author(s)

Bryan Gertzel and Robert Ackland.

Add additional measures to graph as vertex attributes

Description

Adds degree, in-degree, out-degree, betweenness and closeness measures to graph as vertex attributes.

Usage

addAdditionalMeasures(g)

Arguments

Value

An igraph graph object.

Filter out graph vertices not in selected category

Description

This function removes vertices that are not in the selected categories values list or sub-categories.

Usage

applyCategoricalFilters(
  g,
  selected_cat,
  selected_subcats,
  cat_prefix = "vosonCA_"
)

Arguments

Value

An igraph graph object.

Examples

## Not run: 
# return a graph containing only vertices that have the vertex category 
# attribute "vosonCA_Stance" value "liberal"
g <- loadPackageGraph("DividedTheyBlog_40Alist_release.graphml")

g <- applyCategoricalFilters(g, "Stance", c("liberal"))

## End(Not run)

Filter out graph vertices not in component size range

Description

This function removes any graph vertices that are in components that fall outside of the specified component size range.

Usage

applyComponentFilter(g, component_type = "strong", component_range)

Arguments

Value

An igraph graph object.

Filter out graph vertices and edges from graph object that are isolates, multi edge or edge loops

Description

This function removes isolate vertices, multiple edges between vertices and or vertex edge loops from a graph.

Usage

applyGraphFilters(g, isolates = TRUE, multi_edge = TRUE, loops_edge = TRUE)

Arguments

Value

An igraph graph object.

Note

Removing multiple edges or edge loops from a graph will simplify it and remove other edge attributes.

Prune vertices from graph by vertex id

Description

This function removes a list of vertices from the graph object by vertex id value.

Usage

applyPruneFilter(g, selected_prune_verts)

Arguments

Value

An igraph graph object.

Collect reddit data

Description

This function is a wrapper for collecting reddit thread comments using vosonSML::Collect.

Usage

collectRedditData(reddit_url_list)

Arguments

Value

A vosonSML reddit dataframe.

Collect twitter data

Description

This function is a wrapper for collecting tweets using vosonSML::Collect.

Usage

collectTwitterData(
  cred,
  search_term,
  search_type,
  tweet_count,
  include_retweets,
  retry_on_rate_limit,
  language,
  date_until,
  since_id,
  max_id
)

Arguments

Value

A vosonSML twitter dataframe.

Collect youtube data

Description

This function is a wrapper for collecting youtube video comments using vosonSML::Collect.

Usage

collectYoutubeData(
  youtube_api_key,
  youtube_video_id_list,
  youtube_max_comments
)

Arguments

Value

A vosonSML youtube dataframe.

Create a text corpus from graph text attribute data

Description

This function creates a text corpus from node or edge text attribute data in an igraph.

Usage

corpusFromGraph(
  g = NULL,
  txt_attr = NULL,
  type = "vertex",
  iconv = FALSE,
  html_decode = TRUE,
  rm_url = TRUE,
  rm_num = TRUE,
  rm_punct = TRUE,
  rm_twit_hashtags = FALSE,
  rm_twit_users = FALSE,
  sw_kind = "SMART",
  rm_words = NULL,
  stem = FALSE
)

Arguments

Value

A tm text corpus object.

Create reddit actor networks

Description

This function is a wrapper for creating a reddit actor networks using vosonSML::Create.

Usage

createRedditActorNetwork(data)

Arguments

Value

Reddit actor networks as named list.

Create a reddit url to request thread comments

Description

This function creates a url from specified thread url that can be used to request the thread comments.

Usage

createRedditRequestUrl(url)

Arguments

Value

Reddit API url as character string.

Create a twitter auth token id

Description

This function uses properties of the twitter credential object to create a unique token id.

Usage

createTokenId(cred)

Arguments

Value

A token id as character string.

Create twitter actor networks

Description

This function is a wrapper for creating a twitter actor networks using vosonSML::Create.

Usage

createTwitterActorNetwork(data)

Arguments

Value

Twitter actor networks as named list.

Create an auth token with twitter app dev keys

Description

This function is a wrapper for vosonSML::Authenticate with twitter app developer keys. The properties type and created are added to the credential object to assist with VOSONDash token management.

Usage

createTwitterDevToken(app_name, keys)

Arguments

Value

A vosonSML twitter credential object.

Create a auth token with twitter app consumer keys

Description

This function creates a vosonSML::Authenticate credential object with twitter app consumer keys and interactive web authorization. rtweet::create_token is used to create the access token and the properties type and created are added to the credential object to assist with VOSONDash token management.

Usage

createTwitterWebToken(app_name, keys)

Arguments

Value

A vosonSML twitter credential object.

Create youtube actor networks

Description

This function is a wrapper for creating a youtube actor networks using vosonSML::Create.

Usage

createYoutubeNetwork(data)

Arguments

Value

Youtube actor networks as named list.

Load the package included "Divided They Blog" network graph

Description

This is a convenience function to load the "DividedTheyBlog_40Alist_release.graphml" graph.

Usage

dtbGraph()

Value

An igraph graph object.

Examples

## Not run: 
# load the "Divided They Blog" network graph
g <- dtbGraph()

## End(Not run)

Load the package included "Enviro Activist Websites 2006" network graph

Description

This is a convenience function to load the "enviroActivistWebsites_2006.graphml" graph.

Usage

eawGraph()

Value

An igraph graph object.

Examples

## Not run: 
# load the "Enviro Activist Websites 2006" network graph
g <- eawGraph()

## End(Not run)

Create an empty plot with text

Description

This function creates an empty plot that can be used to display a text message. Intended to be used in a series of plots to indicate that an individual plot cannot be created for some reason and still maintain a plot aesthetic.

Usage

emptyPlotMessage(message = "No plot available.")

Arguments

Value

An empty plot with text message.

Get graph network metrics

Description

Function creates a vector of calculated network metrics for a graph.

Usage

getNetworkMetrics(g, component_type = "strong")

Arguments

Value

Network metrics as named vector.

Get subreddit name from url

Description

This function extracts the subreddit name from a reddit thread url.

Usage

getRedditUrlSubreddit(url)

Arguments

Value

Subreddit name as character string.

Get a reddit thread id from url

Description

This function extracts the thread id from a reddit thread url.

Usage

getRedditUrlThreadId(url)

Arguments

Value

Reddit thread id as character string.

Check system fonts

Description

Looks up installed system fonts.

Usage

getSystemFontFamilies()

Value

Returns installed system font families.

Get the VOSONDash package version

Description

This function returns the version of the loaded VOSONDash package.

Usage

getVOSONDashVer()

Value

Package version character string.

Get a list of vertex category attribute names and values

Description

This function returns a list of graph vertex attribute names that match a category attribute prefix format and their unique values.

Usage

getVertexCategories(g, cat_prefix = "vosonCA_")

Arguments

Value

A named list of vertex category attributes and values.

Examples

## Not run: 
# get a list of voson vertex categories and values
g <- loadPackageGraph("DividedTheyBlog_40Alist_release.graphml")

vcats <- getVertexCategories(g)

# vcats
# $Stance
# [1] "conservative" "liberal"  

## End(Not run)

Get the vosonSML package version

Description

This function returns the version of the loaded vosonSML package.

Usage

getVosonSMLVersion()

Value

Package version as character string.

Get a youtube video id from url

Description

This function extracts the youtube video id from a youtube video url.

Usage

getYoutubeVideoId(url)

Arguments

Value

Video id as character string.

Check if graph object has text attributes

Description

This function checks if a graph has either vertex or edge text attributes.

Usage

hasVosonTextData(g)

Arguments

Value

Result as logical.

Note

Uses the VOSON vertex and edge text attribute prefix "vosonTxt_" to determine if attributes are text attributes.

Check if macOS

Description

This function checks if running the macOS version of R.

Usage

isMac()

Value

Result as logical.

Check a value for a range of empty conditions

Description

This function checks a value is not NULL, NA or an empty string.

Usage

isNullOrEmpty(x)

Arguments

Value

Result as logical.

Return logical if vosonSML version later than 0.29

Description

This function returns if the installed version of vosonSML is later than v0.29

Usage

isVosonSML0290()

Value

Logical.

Load package included network graph

Description

This function loads a network graph included in the extdata directory of the VOSONDash package by file name.

Usage

loadPackageGraph(fname)

Arguments

Value

An igraph graph object.

Examples

## Not run: 
# load the "Divided They Blog" package included network graph by file name
g <- loadPackageGraph("DividedTheyBlog_40Alist_release.graphml")

## End(Not run)

Add message to log queue

Description

This function adds a text message to a queue or list with a count limiting how many messages are stored. The queue stores count messages based on first in first out.

Usage

logMessage(messages, add_message, txt = FALSE, count = 20)

Arguments

Value

Messages as vector or character string.

Create a mixing matrix

Description

Function creates a mixing matrix by graph vertex attribute.

Usage

mixmat(g, attrib, use_density = TRUE)

Arguments

Value

A mixing matrix.

Note

Mixing matrix original function written by Gary Weissman. See: https://gist.github.com/gweissman/2402741.

Examples

## Not run: 
# create a mixing matrix of the demonstration network based on vertex 
# categorical attribute for political stance "vosonCA_Stance"
g <- loadPackageGraph("DividedTheyBlog_40Alist_release.graphml")

mm <- mixmat(g, "vosonCA_Stance", use_density = FALSE)

## End(Not run)

Run the VOSON Dashboard Shiny Application

Description

This function launches the VOSONDash Shiny app in the default web browser.

Usage

runVOSONDash(pkgStartupMsgs = FALSE, isLocal = NULL)

Arguments

Value

None

Create a file name with system date time prefix

Description

This function uses the system date and time to create a unique file name.

Usage

systemTimeFilename(name_suffix, name_ext, clean = FALSE)

Arguments

Value

A unique date time file name as character string.

Create a wordcloud plot

Description

This function creates a wordcloud plot from word frequencies.

Usage

wordCloudPlot(
  word_freqs,
  seed = NULL,
  min_freq = 1,
  max_words = 50,
  pcolors = NULL,
  family = NULL,
  ...
)

Arguments

Value

A wordcloud plot.

Create a word frequency chart

Description

This function creates a horizontal barchart of word frequencies.

Usage

wordFreqChart(
  word_freqs,
  min_freq = 1,
  top_count = 20,
  pcolors = NULL,
  family = NULL
)

Arguments

Value

A barchart plot.

Create a word frequency dataframe

Description

Create a word frequency dataframe from a text corpus.

Usage

wordFreqFromCorpus(
  corp,
  rm_sparse = 0.99,
  word_len = c(3, 26),
  word_freq = c(1, Inf)
)

Arguments

Value

A data.table of word frequencies.

Create an NRC emotion chart

Description

This function creates a horizontal barchart measuring and sorting the eight NRC lexicon emotions. Emotions are measured as the proportion of the total value of the eight emotions in the text as a percentage.

Usage

wordSentChart(data, pcolors = NULL)

Arguments

Value

A barchart plot.

Note

Uses the syuzhet package implementation of Saif Mohammad’s NRC Emotion lexicon.

Create NRC emotion data

Description

This function creates an NRC emotion dataframe from a text corpus.

Usage

wordSentData(corp, word_len = c(3, 26))

Arguments

Value

An NRC sentiment dataframe.

Note

Uses the syuzhet package implementation of Saif Mohammad’s NRC emotion lexicon.

Create an NRC sentiment valence chart

Description

This function creates a vertical barchart of the sum of negative and positive sentiments, and the valence or net sentiment in a text corpus.

Usage

wordSentValenceChart(data)

Arguments

Value

A barchart plot.