keyATM: keyATM Main function

In Shusei-E/keyATM-OLD: Keyword Assisted Topic Models

Description

Run keyATM models.

Usage

keyATM(docs, model, no_keyword_topics, keywords = list(),
  model_settings = list(), priors = list(), options = list(),
  keep = c())

Arguments

model	keyATM model: "base", "covariates", and "dynamic"
no_keyword_topics	the number of regular topics
keywords	a list of keywords
model_settings	a list of model specific settings
priors	a list of priors of parameters
options	a list of options
keep	a vector of the names of elements you want to keep in output
keyATM_docs	texts read via keyATM_read()

Value

A keyATM_output object containing:

keyword_k

Number of keyword topics

no_keyword_topics

Number of regular unseeded topics

V

Number of word types

N

Number of documents

theta

Normalized topic proportions for each document

phi

Normalized topic specific word generation probabilities

topic_counts

Number of tokens assigned to each topic

word_counts

Number of times each word type appears

doc_lens

Length of each document in tokens

vocab

Words in the vocabulary

model_fit

Perplexity and log-likelihood

p

Estimated p

values_iter

Organized values stored during iterations

kept_values

Outputs you specified to store.

Examples

## Not run: 
  # keyATM Base
  out <- keyATM(
                docs, model = "base", no_keyword_topics = 5, keywords = keywords_list
               )

  # keyATM Covariates
  out <- keyATM(
                docs, model = "covariates", no_keyword_topics = 5, keywords = keywords_list,
                model_settings(covariates_data = cov)
               )

  # keyATM Dynamic
  out <- keyATM(
                docs, model = "dynamic", no_keyword_topics = 5, keywords = keywords_list,
                model_settings(time_index = time_index_vec, num_states = 5)
               )


## End(Not run)

Shusei-E/keyATM-OLD documentation built on Dec. 23, 2019, 6:42 p.m.