| Title: | Widen, Process, then Re-Tidy Data |
|---|---|
| Description: | Encapsulates the pattern of untidying data into a wide matrix, performing some processing, then turning it back into a tidy form. This is useful for several operations such as co-occurrence counts, correlations, or clustering that are mathematically convenient on wide matrices. |
| Authors: | David Robinson [aut],
Kanishka Misra [ctb],
Julia Silge [aut, cre] |
| Maintainer: | Julia Silge <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.5.9000 |
| Built: | 2024-09-16 03:02:31 UTC |
| Source: | https://github.com/juliasilge/widyr |
Find the Pearson correlation of a sparse matrix.
For large sparse matrix this is more efficient in time and memory than
cor(as.matrix(x)). Note that it does not currently work on
simple_triplet_matrix objects.
cor_sparse(x)cor_sparse(x)
x |
A matrix, potentially a sparse matrix such as a "dgTMatrix" object |
This code comes from mike on this Stack Overflow answer: https://stackoverflow.com/a/9626089/712603.
Find correlations of pairs of items in a column, based on a "feature" column that links them together. This is an example of the spread-operate-retidy pattern.
pairwise_cor( tbl, item, feature, value, method = c("pearson", "kendall", "spearman"), use = "everything", ... ) pairwise_cor_( tbl, item, feature, value, method = c("pearson", "kendall", "spearman"), use = "everything", ... )pairwise_cor( tbl, item, feature, value, method = c("pearson", "kendall", "spearman"), use = "everything", ... ) pairwise_cor_( tbl, item, feature, value, method = c("pearson", "kendall", "spearman"), use = "everything", ... )
tbl |
Table |
item |
Item to compare; will end up in |
feature |
Column describing the feature that links one item to others |
value |
Value column. If not given, defaults to all values being 1 (thus a binary correlation) |
method |
Correlation method |
use |
Character string specifying the behavior of correlations
with missing values; passed on to |
... |
Extra arguments passed on to |
library(dplyr) library(gapminder) gapminder %>% pairwise_cor(country, year, lifeExp) gapminder %>% pairwise_cor(country, year, lifeExp, sort = TRUE) # United Nations voting data if (require("unvotes", quietly = TRUE)) { country_cors <- un_votes %>% mutate(vote = as.numeric(vote)) %>% pairwise_cor(country, rcid, vote, sort = TRUE) }library(dplyr) library(gapminder) gapminder %>% pairwise_cor(country, year, lifeExp) gapminder %>% pairwise_cor(country, year, lifeExp, sort = TRUE) # United Nations voting data if (require("unvotes", quietly = TRUE)) { country_cors <- un_votes %>% mutate(vote = as.numeric(vote)) %>% pairwise_cor(country, rcid, vote, sort = TRUE) }
Count the number of times each pair of items appear together within a group defined by "feature." For example, this could count the number of times two words appear within documents).
pairwise_count(tbl, item, feature, wt = NULL, ...) pairwise_count_(tbl, item, feature, wt = NULL, ...)pairwise_count(tbl, item, feature, wt = NULL, ...) pairwise_count_(tbl, item, feature, wt = NULL, ...)
tbl |
Table |
item |
Item to count pairs of; will end up in |
feature |
Column within which to count pairs
|
wt |
Optionally a weight column, which should have a consistent weight for each feature |
... |
Extra arguments passed on to |
library(dplyr) dat <- tibble(group = rep(1:5, each = 2), letter = c("a", "b", "a", "c", "a", "c", "b", "e", "b", "f")) # count the number of times two letters appear together pairwise_count(dat, letter, group) pairwise_count(dat, letter, group, sort = TRUE) pairwise_count(dat, letter, group, sort = TRUE, diag = TRUE)library(dplyr) dat <- tibble(group = rep(1:5, each = 2), letter = c("a", "b", "a", "c", "a", "c", "b", "e", "b", "f")) # count the number of times two letters appear together pairwise_count(dat, letter, group) pairwise_count(dat, letter, group, sort = TRUE) pairwise_count(dat, letter, group, sort = TRUE, diag = TRUE)
Compute the delta distances (from its two variants) of all pairs of documents in a tidy table.
pairwise_delta(tbl, item, feature, value, method = "burrows", ...) pairwise_delta_(tbl, item, feature, value, method = "burrows", ...)pairwise_delta(tbl, item, feature, value, method = "burrows", ...) pairwise_delta_(tbl, item, feature, value, method = "burrows", ...)
tbl |
Table |
item |
Item to compare; will end up in |
feature |
Column describing the feature that links one item to others |
value |
Value |
method |
Distance measure to be used; see |
... |
Extra arguments passed on to |
library(janeaustenr) library(dplyr) library(tidytext) # closest documents in terms of 1000 most frequent words closest <- austen_books() %>% unnest_tokens(word, text) %>% count(book, word) %>% top_n(1000, n) %>% pairwise_delta(book, word, n, method = "burrows") %>% arrange(delta) closest closest %>% filter(item1 == "Pride & Prejudice") # to remove duplicates, use upper = FALSE closest <- austen_books() %>% unnest_tokens(word, text) %>% count(book, word) %>% top_n(1000, n) %>% pairwise_delta(book, word, n, method = "burrows", upper = FALSE) %>% arrange(delta) # Can also use Argamon's Linear Delta closest <- austen_books() %>% unnest_tokens(word, text) %>% count(book, word) %>% top_n(1000, n) %>% pairwise_delta(book, word, n, method = "argamon", upper = FALSE) %>% arrange(delta)library(janeaustenr) library(dplyr) library(tidytext) # closest documents in terms of 1000 most frequent words closest <- austen_books() %>% unnest_tokens(word, text) %>% count(book, word) %>% top_n(1000, n) %>% pairwise_delta(book, word, n, method = "burrows") %>% arrange(delta) closest closest %>% filter(item1 == "Pride & Prejudice") # to remove duplicates, use upper = FALSE closest <- austen_books() %>% unnest_tokens(word, text) %>% count(book, word) %>% top_n(1000, n) %>% pairwise_delta(book, word, n, method = "burrows", upper = FALSE) %>% arrange(delta) # Can also use Argamon's Linear Delta closest <- austen_books() %>% unnest_tokens(word, text) %>% count(book, word) %>% top_n(1000, n) %>% pairwise_delta(book, word, n, method = "argamon", upper = FALSE) %>% arrange(delta)
Compute distances of all pairs of items in a tidy table.
pairwise_dist(tbl, item, feature, value, method = "euclidean", ...) pairwise_dist_(tbl, item, feature, value, method = "euclidean", ...)pairwise_dist(tbl, item, feature, value, method = "euclidean", ...) pairwise_dist_(tbl, item, feature, value, method = "euclidean", ...)
tbl |
Table |
item |
Item to compare; will end up in |
feature |
Column describing the feature that links one item to others |
value |
Value |
method |
Distance measure to be used; see |
... |
Extra arguments passed on to |
library(gapminder) library(dplyr) # closest countries in terms of life expectancy over time closest <- gapminder %>% pairwise_dist(country, year, lifeExp) %>% arrange(distance) closest closest %>% filter(item1 == "United States") # to remove duplicates, use upper = FALSE gapminder %>% pairwise_dist(country, year, lifeExp, upper = FALSE) %>% arrange(distance) # Can also use Manhattan distance gapminder %>% pairwise_dist(country, year, lifeExp, method = "manhattan", upper = FALSE) %>% arrange(distance)library(gapminder) library(dplyr) # closest countries in terms of life expectancy over time closest <- gapminder %>% pairwise_dist(country, year, lifeExp) %>% arrange(distance) closest closest %>% filter(item1 == "United States") # to remove duplicates, use upper = FALSE gapminder %>% pairwise_dist(country, year, lifeExp, upper = FALSE) %>% arrange(distance) # Can also use Manhattan distance gapminder %>% pairwise_dist(country, year, lifeExp, method = "manhattan", upper = FALSE) %>% arrange(distance)
Find pointwise mutual information of pairs of items in a column, based on a "feature" column that links them together. This is an example of the spread-operate-retidy pattern.
pairwise_pmi(tbl, item, feature, sort = FALSE, ...) pairwise_pmi_(tbl, item, feature, sort = FALSE, ...)pairwise_pmi(tbl, item, feature, sort = FALSE, ...) pairwise_pmi_(tbl, item, feature, sort = FALSE, ...)
tbl |
Table |
item |
Item to compare; will end up in |
feature |
Column describing the feature that links one item to others |
sort |
Whether to sort in descending order of the pointwise mutual information |
... |
Extra arguments passed on to |
A tbl_df with three columns, item1, item2, and
pmi.
library(dplyr) dat <- tibble(group = rep(1:5, each = 2), letter = c("a", "b", "a", "c", "a", "c", "b", "e", "b", "f")) # how informative is each letter about each other letter pairwise_pmi(dat, letter, group) pairwise_pmi(dat, letter, group, sort = TRUE)library(dplyr) dat <- tibble(group = rep(1:5, each = 2), letter = c("a", "b", "a", "c", "a", "c", "b", "e", "b", "f")) # how informative is each letter about each other letter pairwise_pmi(dat, letter, group) pairwise_pmi(dat, letter, group, sort = TRUE)
Compute cosine similarity of all pairs of items in a tidy table.
pairwise_similarity(tbl, item, feature, value, ...) pairwise_similarity_(tbl, item, feature, value, ...)pairwise_similarity(tbl, item, feature, value, ...) pairwise_similarity_(tbl, item, feature, value, ...)
tbl |
Table |
item |
Item to compare; will end up in |
feature |
Column describing the feature that links one item to others |
value |
Value |
... |
Extra arguments passed on to |
library(janeaustenr) library(dplyr) library(tidytext) # Comparing Jane Austen novels austen_words <- austen_books() %>% unnest_tokens(word, text) %>% anti_join(stop_words, by = "word") %>% count(book, word) %>% ungroup() # closest books to each other closest <- austen_words %>% pairwise_similarity(book, word, n) %>% arrange(desc(similarity)) closest closest %>% filter(item1 == "Emma")library(janeaustenr) library(dplyr) library(tidytext) # Comparing Jane Austen novels austen_words <- austen_books() %>% unnest_tokens(word, text) %>% anti_join(stop_words, by = "word") %>% count(book, word) %>% ungroup() # closest books to each other closest <- austen_words %>% pairwise_similarity(book, word, n) %>% arrange(desc(similarity)) closest closest %>% filter(item1 == "Emma")
A special case of widely(). Used to pre-prepare and
post-tidy functions that take an m x n (m items, n features)
matrix and return an m x m (item x item) matrix, such as a
distance or correlation matrix.
squarely(.f, diag = FALSE, upper = TRUE, ...) squarely_(.f, diag = FALSE, upper = TRUE, ...)squarely(.f, diag = FALSE, upper = TRUE, ...) squarely_(.f, diag = FALSE, upper = TRUE, ...)
.f |
Function to wrap |
diag |
Whether to include diagonal (i = j) in output |
upper |
Whether to include upper triangle, which may be duplicated |
... |
Extra arguments passed on to |
Returns a function that takes at least four arguments:
tbl |
A table |
item |
Name of column to use as rows in wide matrix |
feature |
Name of column to use as columns in wide matrix |
feature |
Name of column to use as values in wide matrix |
... |
Arguments passed on to inner function |
widely(), pairwise_count(),
pairwise_cor(), pairwise_dist()
library(dplyr) library(gapminder) closest_continent <- gapminder %>% group_by(continent) %>% squarely(dist)(country, year, lifeExp)library(dplyr) library(gapminder) closest_continent <- gapminder %>% group_by(continent) %>% squarely(dist)(country, year, lifeExp)
Modify a function in order to pre-cast the input into a wide matrix format, perform the function, and then re-tidy (e.g. melt) the output into a tidy table.
widely(.f, sort = FALSE, sparse = FALSE, maximum_size = 1e+07) widely_(.f, sort = FALSE, sparse = FALSE, maximum_size = 1e+07)widely(.f, sort = FALSE, sparse = FALSE, maximum_size = 1e+07) widely_(.f, sort = FALSE, sparse = FALSE, maximum_size = 1e+07)
.f |
Function being wrapped |
sort |
Whether to sort in descending order of |
sparse |
Whether to cast to a sparse matrix |
maximum_size |
To prevent crashing, a maximum size of a non-sparse matrix to be created. Set to NULL to allow any size matrix. |
Returns a function that takes at least four arguments:
tbl |
A table |
row |
Name of column to use as rows in wide matrix |
column |
Name of column to use as columns in wide matrix |
value |
Name of column to use as values in wide matrix |
... |
Arguments passed on to inner function |
widely creates a function that takes those columns as
bare names, widely_ a function that takes them as strings.
library(dplyr) library(gapminder) gapminder gapminder %>% widely(dist)(country, year, lifeExp) # can perform within groups closest_continent <- gapminder %>% group_by(continent) %>% widely(dist)(country, year, lifeExp) closest_continent # for example, find the closest pair in each closest_continent %>% top_n(1, -value)library(dplyr) library(gapminder) gapminder gapminder %>% widely(dist)(country, year, lifeExp) # can perform within groups closest_continent <- gapminder %>% group_by(continent) %>% widely(dist)(country, year, lifeExp) closest_continent # for example, find the closest pair in each closest_continent %>% top_n(1, -value)
Reshape a table that represents pairwise distances into hierarchical clusters,
returning a table with item and cluster columns.
widely_hclust(tbl, item1, item2, distance, k = NULL, h = NULL)widely_hclust(tbl, item1, item2, distance, k = NULL, h = NULL)
tbl |
Table |
item1 |
First item |
item2 |
Second item |
distance |
Distance column |
k |
The desired number of groups |
h |
Height at which to cut the hierarchically clustered tree |
library(gapminder) library(dplyr) # Construct Euclidean distances between countries based on life # expectancy over time country_distances <- gapminder %>% pairwise_dist(country, year, lifeExp) country_distances # Turn this into 5 hierarchical clusters clusters <- country_distances %>% widely_hclust(item1, item2, distance, k = 8) # Examine a few such clusters clusters %>% filter(cluster == 1) clusters %>% filter(cluster == 2)library(gapminder) library(dplyr) # Construct Euclidean distances between countries based on life # expectancy over time country_distances <- gapminder %>% pairwise_dist(country, year, lifeExp) country_distances # Turn this into 5 hierarchical clusters clusters <- country_distances %>% widely_hclust(item1, item2, distance, k = 8) # Examine a few such clusters clusters %>% filter(cluster == 1) clusters %>% filter(cluster == 2)
Given a tidy table of features describing each item, perform k-means
clustering using kmeans() and retidy the data into
one-row-per-cluster.
widely_kmeans(tbl, item, feature, value, k, fill = 0, ...)widely_kmeans(tbl, item, feature, value, k, fill = 0, ...)
tbl |
Table |
item |
Item to cluster (as a bare column name) |
feature |
Feature column (dimension in clustering) |
value |
Value column |
k |
Number of clusters |
fill |
What to fill in for missing values |
... |
Other arguments passed on to |
library(gapminder) library(dplyr) clusters <- gapminder %>% widely_kmeans(country, year, lifeExp, k = 5) clusters clusters %>% count(cluster) # Examine a few clusters clusters %>% filter(cluster == 1) clusters %>% filter(cluster == 2)library(gapminder) library(dplyr) clusters <- gapminder %>% widely_kmeans(country, year, lifeExp, k = 5) clusters clusters %>% count(cluster) # Examine a few clusters clusters %>% filter(cluster == 1) clusters %>% filter(cluster == 2)
This is useful for dimensionality reduction of items, especially when setting a lower nv.
widely_svd(tbl, item, feature, value, nv = NULL, weight_d = FALSE, ...) widely_svd_(tbl, item, feature, value, nv = NULL, weight_d = FALSE, ...)widely_svd(tbl, item, feature, value, nv = NULL, weight_d = FALSE, ...) widely_svd_(tbl, item, feature, value, nv = NULL, weight_d = FALSE, ...)
tbl |
Table |
item |
Item to perform dimensionality reduction on; will end up in |
feature |
Column describing the feature that links one item to others. |
value |
Value |
nv |
Optional; the number of principal components to estimate. Recommended for matrices with many features. |
weight_d |
Whether to multiply each value by the |
... |
Extra arguments passed to |
A tbl_df with three columns. The first is retained from the item input,
then dimension and value. Each row represents one principal component
value.
library(dplyr) library(gapminder) # principal components driving change gapminder_svd <- gapminder %>% widely_svd(country, year, lifeExp) gapminder_svd # compare SVDs, join with other data library(ggplot2) library(tidyr) gapminder_svd %>% spread(dimension, value) %>% inner_join(distinct(gapminder, country, continent), by = "country") %>% ggplot(aes(`1`, `2`, label = country)) + geom_point(aes(color = continent)) + geom_text(vjust = 1, hjust = 1)library(dplyr) library(gapminder) # principal components driving change gapminder_svd <- gapminder %>% widely_svd(country, year, lifeExp) gapminder_svd # compare SVDs, join with other data library(ggplot2) library(tidyr) gapminder_svd %>% spread(dimension, value) %>% inner_join(distinct(gapminder, country, continent), by = "country") %>% ggplot(aes(`1`, `2`, label = country)) + geom_point(aes(color = continent)) + geom_text(vjust = 1, hjust = 1)