diff --git a/DESCRIPTION b/DESCRIPTION index 228c03f..f26802a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: tosca Type: Package Title: Tools for Statistical Content Analysis -Version: 0.1-4 -Date: 2019-05-17 +Version: 0.1-5 +Date: 2019-12-23 Authors@R: c(person("Lars", "Koppers", email="koppers@statistik.tu-dortmund.de", role=c("aut", "cre"), comment = c(ORCID = "0000-0002-1642-9616")), person("Jonas", "Rieger", email="jonas.rieger@tu-dortmund.de", role=c("aut"), comment = c(ORCID = "0000-0002-0007-4478")), person("Karin", "Boczek", email="karin.boczek@tu-dortmund.de", role=c("ctb"), comment = c(ORCID = "0000-0003-1516-4094")), @@ -28,6 +28,6 @@ Suggests: knitr (>= 1.20), devtools (>= 1.13), rmarkdown (>= 1.9) -RoxygenNote: 6.1.1 +RoxygenNote: 7.0.2 LazyData: true VignetteBuilder: knitr diff --git a/man/LDAgen.Rd b/man/LDAgen.Rd index 0fcc1bb..cdf0d5f 100644 --- a/man/LDAgen.Rd +++ b/man/LDAgen.Rd @@ -4,10 +4,20 @@ \alias{LDAgen} \title{Function to fit LDA model} \usage{ -LDAgen(documents, K = 100L, vocab, num.iterations = 200L, - burnin = 70L, alpha = NULL, eta = NULL, seed = NULL, - folder = file.path(tempdir(), "lda-result"), num.words = 50L, - LDA = TRUE, count = FALSE) +LDAgen( + documents, + K = 100L, + vocab, + num.iterations = 200L, + burnin = 70L, + alpha = NULL, + eta = NULL, + seed = NULL, + folder = file.path(tempdir(), "lda-result"), + num.words = 50L, + LDA = TRUE, + count = FALSE +) } \arguments{ \item{documents}{A list prepared by \code{\link{LDAprep}}.} diff --git a/man/as.corpus.textmeta.Rd b/man/as.corpus.textmeta.Rd index b40151a..82aeda1 100644 --- a/man/as.corpus.textmeta.Rd +++ b/man/as.corpus.textmeta.Rd @@ -4,9 +4,13 @@ \alias{as.corpus.textmeta} \title{Transform textmeta to corpus} \usage{ -as.corpus.textmeta(object, docnames = "id", +as.corpus.textmeta( + object, + docnames = "id", docvars = setdiff(colnames(object$meta), "id"), - metadoc = character(), ...) + metadoc = character(), + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object} diff --git a/man/as.meta.Rd b/man/as.meta.Rd index 01c72cd..de0bf7a 100644 --- a/man/as.meta.Rd +++ b/man/as.meta.Rd @@ -4,8 +4,14 @@ \alias{as.meta} \title{"meta" Component of "textmeta"-Objects} \usage{ -as.meta(x, cols = colnames(x), idCol = "id", dateCol = "date", - titleCol = "title", dateFormat) +as.meta( + x, + cols = colnames(x), + idCol = "id", + dateCol = "date", + titleCol = "title", + dateFormat +) } \arguments{ \item{x}{data.frame to convert} diff --git a/man/as.textmeta.corpus.Rd b/man/as.textmeta.corpus.Rd index 1d0943a..ca499c2 100644 --- a/man/as.textmeta.corpus.Rd +++ b/man/as.textmeta.corpus.Rd @@ -4,9 +4,17 @@ \alias{as.textmeta.corpus} \title{Transform corpus to textmeta} \usage{ -as.textmeta.corpus(corpus, cols, dateFormat = "\%Y-\%m-\%d", - idCol = "id", dateCol = "date", titleCol = "title", - textCol = "texts", duplicateAction = TRUE, addMetadata = TRUE) +as.textmeta.corpus( + corpus, + cols, + dateFormat = "\%Y-\%m-\%d", + idCol = "id", + dateCol = "date", + titleCol = "title", + textCol = "texts", + duplicateAction = TRUE, + addMetadata = TRUE +) } \arguments{ \item{corpus}{Object of class \code{\link[quanteda]{corpus}}, diff --git a/man/cleanTexts.Rd b/man/cleanTexts.Rd index a2d51d0..50f38d9 100644 --- a/man/cleanTexts.Rd +++ b/man/cleanTexts.Rd @@ -4,9 +4,17 @@ \alias{cleanTexts} \title{Data Preprocessing} \usage{ -cleanTexts(object, text, sw = "en", paragraph = FALSE, - lowercase = TRUE, rmPunctuation = TRUE, rmNumbers = TRUE, - checkUTF8 = TRUE, ucp = TRUE) +cleanTexts( + object, + text, + sw = "en", + paragraph = FALSE, + lowercase = TRUE, + rmPunctuation = TRUE, + rmNumbers = TRUE, + checkUTF8 = TRUE, + ucp = TRUE +) } \arguments{ \item{object}{\code{\link{textmeta}} object} diff --git a/man/clusterTopics.Rd b/man/clusterTopics.Rd index 0f52f64..9be135f 100644 --- a/man/clusterTopics.Rd +++ b/man/clusterTopics.Rd @@ -4,8 +4,15 @@ \alias{clusterTopics} \title{Cluster Analysis} \usage{ -clusterTopics(ldaresult, file, tnames = NULL, method = "average", - width = 30, height = 15, ...) +clusterTopics( + ldaresult, + file, + tnames = NULL, + method = "average", + width = 30, + height = 15, + ... +) } \arguments{ \item{ldaresult}{The result of a function call \code{\link{LDAgen}} - diff --git a/man/filterCount.Rd b/man/filterCount.Rd index df3bc96..fe473b5 100644 --- a/man/filterCount.Rd +++ b/man/filterCount.Rd @@ -8,11 +8,15 @@ \usage{ filterCount(...) -\method{filterCount}{default}(text, count = 1L, out = c("text", "bin", - "count"), ...) - -\method{filterCount}{textmeta}(object, count = 1L, out = c("text", - "bin", "count"), filtermeta = TRUE, ...) +\method{filterCount}{default}(text, count = 1L, out = c("text", "bin", "count"), ...) + +\method{filterCount}{textmeta}( + object, + count = 1L, + out = c("text", "bin", "count"), + filtermeta = TRUE, + ... +) } \arguments{ \item{...}{Not used.} diff --git a/man/filterDate.Rd b/man/filterDate.Rd index 9843a0b..3cf23a1 100644 --- a/man/filterDate.Rd +++ b/man/filterDate.Rd @@ -8,12 +8,21 @@ \usage{ filterDate(...) -\method{filterDate}{default}(text, meta, s.date = min(meta$date, na.rm = - TRUE), e.date = max(meta$date, na.rm = TRUE), ...) +\method{filterDate}{default}( + text, + meta, + s.date = min(meta$date, na.rm = TRUE), + e.date = max(meta$date, na.rm = TRUE), + ... +) -\method{filterDate}{textmeta}(object, s.date = min(object$meta$date, - na.rm = TRUE), e.date = max(object$meta$date, na.rm = TRUE), - filtermeta = TRUE, ...) +\method{filterDate}{textmeta}( + object, + s.date = min(object$meta$date, na.rm = TRUE), + e.date = max(object$meta$date, na.rm = TRUE), + filtermeta = TRUE, + ... +) } \arguments{ \item{...}{Not used.} diff --git a/man/filterWord.Rd b/man/filterWord.Rd index d7862d4..a761b93 100644 --- a/man/filterWord.Rd +++ b/man/filterWord.Rd @@ -8,11 +8,22 @@ \usage{ filterWord(...) -\method{filterWord}{default}(text, search, ignore.case = FALSE, - out = c("text", "bin", "count"), ...) +\method{filterWord}{default}( + text, + search, + ignore.case = FALSE, + out = c("text", "bin", "count"), + ... +) -\method{filterWord}{textmeta}(object, search, ignore.case = FALSE, - out = c("text", "bin", "count"), filtermeta = TRUE, ...) +\method{filterWord}{textmeta}( + object, + search, + ignore.case = FALSE, + out = c("text", "bin", "count"), + filtermeta = TRUE, + ... +) } \arguments{ \item{...}{Not used.} diff --git a/man/intruderTopics.Rd b/man/intruderTopics.Rd index 1437845..5d0a4b4 100644 --- a/man/intruderTopics.Rd +++ b/man/intruderTopics.Rd @@ -4,10 +4,22 @@ \alias{intruderTopics} \title{Function to validate the fit of the LDA model} \usage{ -intruderTopics(text = NULL, beta = NULL, theta = NULL, id = NULL, - numIntruder = 1, numOuttopics = 4, byScore = TRUE, minWords = 0L, - minOuttopics = 0L, stopTopics = NULL, printSolution = FALSE, - oldResult = NULL, test = FALSE, testinput = NULL) +intruderTopics( + text = NULL, + beta = NULL, + theta = NULL, + id = NULL, + numIntruder = 1, + numOuttopics = 4, + byScore = TRUE, + minWords = 0L, + minOuttopics = 0L, + stopTopics = NULL, + printSolution = FALSE, + oldResult = NULL, + test = FALSE, + testinput = NULL +) } \arguments{ \item{text}{A list of texts (e.g. the text element of a \code{\link{textmeta}} object).} diff --git a/man/intruderWords.Rd b/man/intruderWords.Rd index f30bd2b..aedd0b7 100644 --- a/man/intruderWords.Rd +++ b/man/intruderWords.Rd @@ -4,10 +4,18 @@ \alias{intruderWords} \title{Function to validate the fit of the LDA model} \usage{ -intruderWords(beta = NULL, byScore = TRUE, numTopwords = 30L, - numIntruder = 1L, numOutwords = 5L, noTopic = TRUE, - printSolution = FALSE, oldResult = NULL, test = FALSE, - testinput = NULL) +intruderWords( + beta = NULL, + byScore = TRUE, + numTopwords = 30L, + numIntruder = 1L, + numOutwords = 5L, + noTopic = TRUE, + printSolution = FALSE, + oldResult = NULL, + test = FALSE, + testinput = NULL +) } \arguments{ \item{beta}{A matrix of word-probabilities or frequency table for the topics (e.g. the \code{topics} matrix from the \code{\link{LDAgen}} result). Each row is a topic, each column a word. The rows will be divided by the row sums, if they are not 1.} diff --git a/man/plotArea.Rd b/man/plotArea.Rd index d70b348..6caa66a 100644 --- a/man/plotArea.Rd +++ b/man/plotArea.Rd @@ -4,10 +4,22 @@ \alias{plotArea} \title{Plotting topics over time as stacked areas below plotted lines.} \usage{ -plotArea(ldaresult, ldaID, select = NULL, tnames = NULL, - threshold = NULL, meta, unit = "quarter", xunit = "year", - color = NULL, sort = TRUE, legend = NULL, legendLimit = 0, - peak = 0, file) +plotArea( + ldaresult, + ldaID, + select = NULL, + tnames = NULL, + threshold = NULL, + meta, + unit = "quarter", + xunit = "year", + color = NULL, + sort = TRUE, + legend = NULL, + legendLimit = 0, + peak = 0, + file +) } \arguments{ \item{ldaresult}{LDA result object} diff --git a/man/plotFreq.Rd b/man/plotFreq.Rd index 9a41995..1d6318c 100644 --- a/man/plotFreq.Rd +++ b/man/plotFreq.Rd @@ -4,11 +4,31 @@ \alias{plotFreq} \title{Plotting Counts of specified Wordgroups over Time (relative to Corpus)} \usage{ -plotFreq(object, id = names(object$text), type = c("docs", "words"), - wordlist, link = c("and", "or"), wnames, ignore.case = FALSE, - rel = FALSE, mark = TRUE, unit = "month", curves = c("exact", - "smooth", "both"), smooth = 0.05, both.lwd, both.lty, main, xlab, ylab, - ylim, col, legend = "topright", natozero = TRUE, file, ...) +plotFreq( + object, + id = names(object$text), + type = c("docs", "words"), + wordlist, + link = c("and", "or"), + wnames, + ignore.case = FALSE, + rel = FALSE, + mark = TRUE, + unit = "month", + curves = c("exact", "smooth", "both"), + smooth = 0.05, + both.lwd, + both.lty, + main, + xlab, + ylab, + ylim, + col, + legend = "topright", + natozero = TRUE, + file, + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object with strictly tokenized diff --git a/man/plotHeat.Rd b/man/plotHeat.Rd index 7278fee..fc2480a 100644 --- a/man/plotHeat.Rd +++ b/man/plotHeat.Rd @@ -4,9 +4,19 @@ \alias{plotHeat} \title{Plotting Topics over Time relative to Corpus} \usage{ -plotHeat(object, ldaresult, ldaID, - select = 1:nrow(ldaresult$document_sums), tnames, norm = FALSE, file, - unit = "year", date_breaks = 1, margins = c(5, 0), ...) +plotHeat( + object, + ldaresult, + ldaID, + select = 1:nrow(ldaresult$document_sums), + tnames, + norm = FALSE, + file, + unit = "year", + date_breaks = 1, + margins = c(5, 0), + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object with strictly tokenized \code{text} diff --git a/man/plotScot.Rd b/man/plotScot.Rd index 218f98a..7aa6d00 100644 --- a/man/plotScot.Rd +++ b/man/plotScot.Rd @@ -4,10 +4,26 @@ \alias{plotScot} \title{Plots Counts of Documents or Words over Time (relative to Corpus)} \usage{ -plotScot(object, id = object$meta$id, type = c("docs", "words"), - rel = FALSE, mark = TRUE, unit = "month", curves = c("exact", - "smooth", "both"), smooth = 0.05, main, xlab, ylab, ylim, both.lwd, - both.col, both.lty, natozero = TRUE, file, ...) +plotScot( + object, + id = object$meta$id, + type = c("docs", "words"), + rel = FALSE, + mark = TRUE, + unit = "month", + curves = c("exact", "smooth", "both"), + smooth = 0.05, + main, + xlab, + ylab, + ylim, + both.lwd, + both.col, + both.lty, + natozero = TRUE, + file, + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object with strictly tokenized diff --git a/man/plotTopic.Rd b/man/plotTopic.Rd index 7addb5d..5d56879 100644 --- a/man/plotTopic.Rd +++ b/man/plotTopic.Rd @@ -4,12 +4,30 @@ \alias{plotTopic} \title{Plotting Counts of Topics over Time (Relative to Corpus)} \usage{ -plotTopic(object, ldaresult, ldaID, - select = 1:nrow(ldaresult$document_sums), tnames, rel = FALSE, - mark = TRUE, unit = "month", curves = c("exact", "smooth", "both"), - smooth = 0.05, main, xlab, ylim, ylab, both.lwd, both.lty, col, +plotTopic( + object, + ldaresult, + ldaID, + select = 1:nrow(ldaresult$document_sums), + tnames, + rel = FALSE, + mark = TRUE, + unit = "month", + curves = c("exact", "smooth", "both"), + smooth = 0.05, + main, + xlab, + ylim, + ylab, + both.lwd, + both.lty, + col, legend = ifelse(pages, "onlyLast:topright", "topright"), - pages = FALSE, natozero = TRUE, file, ...) + pages = FALSE, + natozero = TRUE, + file, + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object with strictly tokenized diff --git a/man/plotTopicWord.Rd b/man/plotTopicWord.Rd index 373ecee..e0bc2a1 100644 --- a/man/plotTopicWord.Rd +++ b/man/plotTopicWord.Rd @@ -4,13 +4,34 @@ \alias{plotTopicWord} \title{Plotting Counts of Topics-Words-Combination over Time (Relative to Words)} \usage{ -plotTopicWord(object, docs, ldaresult, ldaID, - wordlist = lda::top.topic.words(ldaresult$topics, 1), link = c("and", - "or"), select = 1:nrow(ldaresult$document_sums), tnames, wnames, - rel = FALSE, mark = TRUE, unit = "month", curves = c("exact", - "smooth", "both"), smooth = 0.05, legend = ifelse(pages, - "onlyLast:topright", "topright"), pages = FALSE, natozero = TRUE, - file, main, xlab, ylab, ylim, both.lwd, both.lty, col, ...) +plotTopicWord( + object, + docs, + ldaresult, + ldaID, + wordlist = lda::top.topic.words(ldaresult$topics, 1), + link = c("and", "or"), + select = 1:nrow(ldaresult$document_sums), + tnames, + wnames, + rel = FALSE, + mark = TRUE, + unit = "month", + curves = c("exact", "smooth", "both"), + smooth = 0.05, + legend = ifelse(pages, "onlyLast:topright", "topright"), + pages = FALSE, + natozero = TRUE, + file, + main, + xlab, + ylab, + ylim, + both.lwd, + both.lty, + col, + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object with strictly tokenized diff --git a/man/plotWordSub.Rd b/man/plotWordSub.Rd index ae48fe6..5b41acc 100644 --- a/man/plotWordSub.Rd +++ b/man/plotWordSub.Rd @@ -4,12 +4,34 @@ \alias{plotWordSub} \title{Plotting Counts/Proportion of Words/Docs in LDA-generated Topic-Subcorpora over Time} \usage{ -plotWordSub(object, ldaresult, ldaID, limit = 10, alloc = c("multi", - "unique", "best"), select = 1:nrow(ldaresult$document_sums), tnames, - search, ignore.case = TRUE, type = c("docs", "words"), rel = TRUE, - mark = TRUE, unit = "month", curves = c("exact", "smooth", "both"), - smooth = 0.05, main, xlab, ylab, ylim, both.lwd, both.lty, col, - legend = "topright", natozero = TRUE, file, ...) +plotWordSub( + object, + ldaresult, + ldaID, + limit = 10, + alloc = c("multi", "unique", "best"), + select = 1:nrow(ldaresult$document_sums), + tnames, + search, + ignore.case = TRUE, + type = c("docs", "words"), + rel = TRUE, + mark = TRUE, + unit = "month", + curves = c("exact", "smooth", "both"), + smooth = 0.05, + main, + xlab, + ylab, + ylim, + both.lwd, + both.lty, + col, + legend = "topright", + natozero = TRUE, + file, + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object with strictly tokenized diff --git a/man/plotWordpt.Rd b/man/plotWordpt.Rd index a24c5e7..d92edcb 100644 --- a/man/plotWordpt.Rd +++ b/man/plotWordpt.Rd @@ -4,13 +4,34 @@ \alias{plotWordpt} \title{Plots Counts of Topics-Words-Combination over Time (Relative to Topics)} \usage{ -plotWordpt(object, docs, ldaresult, ldaID, - select = 1:nrow(ldaresult$document_sums), link = c("and", "or"), - wordlist = lda::top.topic.words(ldaresult$topics, 1), tnames, wnames, - rel = FALSE, mark = TRUE, unit = "month", curves = c("exact", - "smooth", "both"), smooth = 0.05, legend = ifelse(pages, - "onlyLast:topright", "topright"), pages = FALSE, natozero = TRUE, - file, main, xlab, ylab, ylim, both.lwd, both.lty, col, ...) +plotWordpt( + object, + docs, + ldaresult, + ldaID, + select = 1:nrow(ldaresult$document_sums), + link = c("and", "or"), + wordlist = lda::top.topic.words(ldaresult$topics, 1), + tnames, + wnames, + rel = FALSE, + mark = TRUE, + unit = "month", + curves = c("exact", "smooth", "both"), + smooth = 0.05, + legend = ifelse(pages, "onlyLast:topright", "topright"), + pages = FALSE, + natozero = TRUE, + file, + main, + xlab, + ylab, + ylim, + both.lwd, + both.lty, + col, + ... +) } \arguments{ \item{object}{\code{\link{textmeta}} object with strictly tokenized diff --git a/man/readTextmeta.Rd b/man/readTextmeta.Rd index 7301b61..31a6b32 100644 --- a/man/readTextmeta.Rd +++ b/man/readTextmeta.Rd @@ -4,10 +4,19 @@ \alias{readTextmeta} \title{Read Corpora as CSV} \usage{ -readTextmeta(path, file, cols, dateFormat = "\%Y-\%m-\%d", - idCol = "id", dateCol = "date", titleCol = "title", - textCol = "text", encoding = "UTF-8", xmlAction = TRUE, - duplicateAction = TRUE) +readTextmeta( + path, + file, + cols, + dateFormat = "\%Y-\%m-\%d", + idCol = "id", + dateCol = "date", + titleCol = "title", + textCol = "text", + encoding = "UTF-8", + xmlAction = TRUE, + duplicateAction = TRUE +) } \arguments{ \item{path}{\code{character} string with path where the data files are} diff --git a/man/readWiki.Rd b/man/readWiki.Rd index cf2be8e..88e05f0 100644 --- a/man/readWiki.Rd +++ b/man/readWiki.Rd @@ -4,8 +4,12 @@ \alias{readWiki} \title{Read Pages from Wikipedia} \usage{ -readWiki(category, subcategories = TRUE, language = "en", - project = "wikipedia") +readWiki( + category, + subcategories = TRUE, + language = "en", + project = "wikipedia" +) } \arguments{ \item{category}{\code{character} articles of which category should be diff --git a/man/readWikinews.Rd b/man/readWikinews.Rd index a934bb6..fd234ca 100644 --- a/man/readWikinews.Rd +++ b/man/readWikinews.Rd @@ -4,8 +4,11 @@ \alias{readWikinews} \title{Read files from Wikinews} \usage{ -readWikinews(path = getwd(), file = list.files(path = path, pattern = - "*.xml$", full.names = FALSE, recursive = TRUE)) +readWikinews( + path = getwd(), + file = list.files(path = path, pattern = "*.xml$", full.names = FALSE, recursive = + TRUE) +) } \arguments{ \item{path}{Path where the data files are.} diff --git a/man/removeXML.Rd b/man/removeXML.Rd index 2f308ac..f2ab6e4 100644 --- a/man/removeXML.Rd +++ b/man/removeXML.Rd @@ -10,8 +10,15 @@ removeXML(x) removeUmlauts(x) -removeHTML(x, dec = TRUE, hex = TRUE, entity = TRUE, - symbolList = c(1:4, 9, 13, 15, 16), delete = TRUE, symbols = FALSE) +removeHTML( + x, + dec = TRUE, + hex = TRUE, + entity = TRUE, + symbolList = c(1:4, 9, 13, 15, 16), + delete = TRUE, + symbols = FALSE +) } \arguments{ \item{x}{Character: Vector or list of character vectors.} @@ -46,7 +53,7 @@ x <- "ø ø ø" removeHTML(x=x, symbolList = 1, dec=TRUE, hex=FALSE, entity=FALSE, delete = FALSE) removeHTML(x=x, symbolList = c(1,3)) -y <- c("Bl\\UFChende Apfelb\\UE4ume") +y <- c("Bl\UFChende Apfelb\UE4ume") removeUmlauts(y) } diff --git a/man/showMeta.Rd b/man/showMeta.Rd index 30992bd..c587a8e 100644 --- a/man/showMeta.Rd +++ b/man/showMeta.Rd @@ -4,8 +4,13 @@ \alias{showMeta} \title{Export Readable Meta-Data of Articles.} \usage{ -showMeta(meta, id = meta$id, cols = colnames(meta), file, - fileEncoding = "UTF-8") +showMeta( + meta, + id = meta$id, + cols = colnames(meta), + file, + fileEncoding = "UTF-8" +) } \arguments{ \item{meta}{A data.frame of meta-data as a result of a read-function.} diff --git a/man/showTexts.Rd b/man/showTexts.Rd index deea16c..6efdaef 100644 --- a/man/showTexts.Rd +++ b/man/showTexts.Rd @@ -4,8 +4,7 @@ \alias{showTexts} \title{Exports Readable Text Lists} \usage{ -showTexts(object, id = names(object$text), file, - fileEncoding = "UTF-8") +showTexts(object, id = names(object$text), file, fileEncoding = "UTF-8") } \arguments{ \item{object}{\code{\link{textmeta}} object} diff --git a/man/textmeta.Rd b/man/textmeta.Rd index 115ef47..217b899 100644 --- a/man/textmeta.Rd +++ b/man/textmeta.Rd @@ -8,15 +8,13 @@ \alias{plot.textmeta} \title{"textmeta"-Objects} \usage{ -textmeta(meta = NULL, text = NULL, metamult = NULL, - dateFormat = "\%Y-\%m-\%d") +textmeta(meta = NULL, text = NULL, metamult = NULL, dateFormat = "\%Y-\%m-\%d") is.textmeta(x) \method{print}{textmeta}(x, ...) -\method{summary}{textmeta}(object, listnames = names(object), - metavariables = character(), ...) +\method{summary}{textmeta}(object, listnames = names(object), metavariables = character(), ...) \method{plot}{textmeta}(x, ...) } diff --git a/man/topTexts.Rd b/man/topTexts.Rd index becd0d9..d676731 100644 --- a/man/topTexts.Rd +++ b/man/topTexts.Rd @@ -4,8 +4,15 @@ \alias{topTexts} \title{Get The IDs Of The Most Representive Texts} \usage{ -topTexts(ldaresult, ldaID, limit = 20L, rel = TRUE, - select = 1:nrow(ldaresult$document_sums), tnames, minlength = 30L) +topTexts( + ldaresult, + ldaID, + limit = 20L, + rel = TRUE, + select = 1:nrow(ldaresult$document_sums), + tnames, + minlength = 30L +) } \arguments{ \item{ldaresult}{LDA result} diff --git a/man/topWords.Rd b/man/topWords.Rd index e55ebf9..0f5134b 100644 --- a/man/topWords.Rd +++ b/man/topWords.Rd @@ -5,8 +5,7 @@ \alias{importance} \title{Top Words per Topic} \usage{ -topWords(topics, numWords = 1, byScore = TRUE, epsilon = 1e-05, - values = FALSE) +topWords(topics, numWords = 1, byScore = TRUE, epsilon = 1e-05, values = FALSE) importance(topics, epsilon = 1e-05) } diff --git a/man/topicCoherence.Rd b/man/topicCoherence.Rd index 3353416..51aa8c6 100644 --- a/man/topicCoherence.Rd +++ b/man/topicCoherence.Rd @@ -4,8 +4,14 @@ \alias{topicCoherence} \title{Calculating Topic Coherence} \usage{ -topicCoherence(ldaresult, documents, num.words = 10, by.score = TRUE, - sym.coherence = FALSE, epsilon = 1) +topicCoherence( + ldaresult, + documents, + num.words = 10, + by.score = TRUE, + sym.coherence = FALSE, + epsilon = 1 +) } \arguments{ \item{ldaresult}{The result of a function call \code{\link{LDAgen}}} diff --git a/man/topicsInText.Rd b/man/topicsInText.Rd index 7838dc0..4611ab8 100644 --- a/man/topicsInText.Rd +++ b/man/topicsInText.Rd @@ -4,10 +4,21 @@ \alias{topicsInText} \title{Coloring the words of a text corresponding to topic allocation} \usage{ -topicsInText(text, ldaID, id, ldaresult, label = NULL, vocab, - wordOrder = c("both", "alphabetical", "topics", ""), colors = NULL, - fixColors = FALSE, meta = NULL, originaltext = NULL, - unclearTopicAssignment = TRUE, htmlreturn = FALSE) +topicsInText( + text, + ldaID, + id, + ldaresult, + label = NULL, + vocab, + wordOrder = c("both", "alphabetical", "topics", ""), + colors = NULL, + fixColors = FALSE, + meta = NULL, + originaltext = NULL, + unclearTopicAssignment = TRUE, + htmlreturn = FALSE +) } \arguments{ \item{text}{The result of \code{\link{LDAprep}}}