as.LDABatch: LDABatch Constructor

In JonasRieger/ldaPrototype: Prototype of Multiple Latent Dirichlet Allocation Runs

LDABatch Constructor

Description

Constructs a LDABatch object for given elements reg, job and id.

Usage

as.LDABatch(reg, job, id)

is.LDABatch(obj, verbose = FALSE)

Arguments

reg	[Registry] Registry. See findDone.
job	[data.frame or integer] A data.frame or data.table with a column named "job.id" or a vector of integerish job ids. See reduceResultsList.
id	[character(1)] A name for the registry. If not passed, the folder's name is extracted from reg.
obj	[R object] Object to test.
verbose	[logical(1)] Should test information be given in the console?

Details

Given a Registry the function returns a LDABatch object, which can be handled using the getter functions at getJob.

Value

[named list] with entries id for the registry's folder name, jobs for the submitted jobs' ids and its parameter settings and reg for the registry itself.

See Also

Other constructor functions: LDA(), as.LDARep()

Other batch functions: LDABatch(), getJob(), mergeBatchTopics()

Examples

## Not run: 
batch = LDABatch(docs = reuters_docs, vocab = reuters_vocab, K = 15, chunk.size = 20)
batch

batch2 = as.LDABatch(reg = getRegistry(batch))
batch2
head(getJob(batch2))

batch3 = as.LDABatch()
batch3

### one way of loading an existing registry ###
batchtools::loadRegistry("LDABatch")
batch = as.LDABatch()

## End(Not run)

JonasRieger/ldaPrototype documentation built on Feb. 5, 2023, 6:45 p.m.