fst_freq: Find and Plot Top Words

View source: R/02_data_exploration.R

fst_freqR Documentation

Find and Plot Top Words

Description

Creates a plot of the most frequently-occurring words (unigrams) within the data. Optionally, weights can be provided either through a 'weight' column in the formatted data, or from a 'svydesign' object with the raw (preformatted) data.

Usage

fst_freq(
  data,
  number = 10,
  norm = NULL,
  pos_filter = NULL,
  strict = TRUE,
  name = NULL,
  use_svydesign_weights = FALSE,
  id = "",
  svydesign = NULL,
  use_column_weights = FALSE
)

Arguments

data

A dataframe of text in CoNLL-U format, with optional additional columns.

number

The number of top words to return, default is '10'.

norm

The method for normalising the data. Valid settings are '"number_words"' (the number of words in the responses, default), '"number_resp"' (the number of responses), or 'NULL' (raw count returned).

pos_filter

List of UPOS tags for inclusion, default is 'NULL' which means all word types included.

strict

Whether to strictly cut-off at 'number' (ties are alphabetically ordered), default is 'TRUE'.

name

An optional "name" for the plot to add to title, default is 'NULL'.

use_svydesign_weights

Option to weight words in the plot using weights from a 'svydesign' containing the raw data, default is 'FALSE'

id

ID column from raw data, required if 'use_svydesign_weights = TRUE' and must match the 'docid' in formatted 'data'.

svydesign

A 'svydesign' which contains the raw data and weights, required if 'use_svydesign_weights = TRUE'.

use_column_weights

Option to weight words in the plot using weights from formatted data which includes addition 'weight' column, default is 'FALSE'

Value

Plot of top words.

Examples

fst_freq(fst_child, number = 12, norm = 'number_resp',  name = "All")
fst_freq(fst_child, use_column_weights = TRUE)
s <- survey::svydesign(id=~1, weights= ~paino, data = child)
i <- 'fsd_id'
fst_freq(fst_child_2, use_svydesign_weights = TRUE, svydesign = s, id = i)

finnsurveytext documentation built on April 4, 2025, 5:07 a.m.