# Toolkit for Corpus Analysis

## Documentation for package ‘polmineR’ version 0.8.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.

## Help Pages

A B C D E F G H I K L M N O P R S T U V W Z misc

polmineR-package | polmineR-package

## -- A --

aggregate-method | Virtual class slice.
annotations | Annotation functionality
annotations-method | Annotation functionality
annotations<- | Annotation functionality
annotations<--method | Annotation functionality
as | Get VCorpus.
as.bundle | S4 textstat superclass.
as.bundle-method | Bundle Class
as.character-method | S4 kwic class
as.corpusEnc | Conversion between corpus and native encoding.
as.cqp | Tools for CQP queries.
as.data.frame-method | Cooccurrences class.
as.data.frame-method | S4 kwic class
as.data.frame-method | S4 textstat superclass.
as.data.table-method | S4 textstat superclass.
as.data.table.bundle | Bundle Class
as.data.table.regions | Regions of a CWB corpus.
as.data.table.textstat | S4 textstat superclass.
as.DataTables-method | Context class.
as.DataTables-method | S4 textstat superclass.
as.DocumentTermMatrix | Generate TermDocumentMatrix / DocumentTermMatrix.
as.DocumentTermMatrix-method | Generate TermDocumentMatrix / DocumentTermMatrix.
as.DocumentTermMatrix-method | S4 kwic class
as.list-method | Bundle Class
as.markdown | Get markdown-formatted full text of a partition.
as.markdown-method | Get markdown-formatted full text of a partition.
as.matrix-method | Bundle Class
as.matrix-method | Analyze context of a node word.
as.matrix-method | Bundle of partitions (partition_bundle class).
as.nativeEnc | Conversion between corpus and native encoding.
as.partitionBundle | Renamed Functions
as.partition_bundle | Partition class and methods.
as.partition_bundle-method | Bundle of partitions (partition_bundle class).
as.partition_bundle-method | Partition class and methods.
as.regions | Regions of a CWB corpus.
as.regions-method | Context class.
as.regions-method | Partition class and methods.
as.simple_triplet_matrix-method | Cooccurrences class for corpus/partition.
as.sparseMatrix | Type conversion - get sparseMatrix.
as.sparseMatrix-method | Cooccurrences class for corpus/partition.
as.sparseMatrix-method | Type conversion - get sparseMatrix.
as.speeches | Split corpus or partition into speeches.
as.speeches-method | Split corpus or partition into speeches.
as.TermDocumentMatrix | Generate TermDocumentMatrix / DocumentTermMatrix.
as.TermDocumentMatrix-method | Generate TermDocumentMatrix / DocumentTermMatrix.
as.TermDocumentMatrix-method | S4 kwic class
as.utf8 | Conversion between corpus and native encoding.
as.VCorpus | Get VCorpus.
as.VCorpus-method | Get VCorpus.
as_igraph | Cooccurrences class for corpus/partition.
as_igraph-method | Cooccurrences class for corpus/partition.

## -- B --

barplot-method | Bundle of partitions (partition_bundle class).
blapply | apply a function over a list or bundle
blapply-method | apply a function over a list or bundle
browse | Defunct methods and functions.
bundle | Bundle Class
bundle-class | Bundle Class

## -- C --

check_cqp_query | Tools for CQP queries.
chisquare | Perform chisquare-text.
chisquare-method | Perform chisquare-text.
colnames-method | S4 textstat superclass.
context | Analyze context of a node word.
context-class | Context class.
context-method | Analyze context of a node word.
context_bundle-class | S4 context_bundle class
Cooccurrences | Get all cooccurrences in corpus/partition.
cooccurrences | Get cooccurrence statistics.
Cooccurrences-class | Cooccurrences class for corpus/partition.
cooccurrences-class | Cooccurrences class.
Cooccurrences-method | Get all cooccurrences in corpus/partition.
cooccurrences-method | Get cooccurrence statistics.
cooccurrences_bundle | Cooccurrences class.
cooccurrences_bundle-class | Cooccurrences class.
cooccurrences_reshaped-class | Cooccurrences class.
Corpus | Defunct methods and functions.
corpus | Corpus class initialization
corpus-class | Corpus class initialization
corpus-method | Corpus class initialization
corpus-method | Renamed Functions
corpus-methods | Corpus class methods
CorpusOrSubcorpus | Regions of a CWB corpus.
CorpusOrSubcorpus-class | Regions of a CWB corpus.
count | Get counts.
count-class | Count class.
count-method | Context class.
count-method | Get counts.
count-method | S4 kwic class
count_bundle-class | Count class.
count_class | Count class.
cpos | Get corpus positions for a query or queries.
cpos-method | Get corpus positions for a query or queries.
cqp | Tools for CQP queries.

## -- D --

data_dir | Get registry and data directories.
decode | Decode corpus or subcorpus.
decode-method | Cooccurrences class for corpus/partition.
decode-method | Decode corpus or subcorpus.
dim-method | S4 textstat superclass.
dispersion | Dispersion of a query or multiple queries.
dispersion-method | Dispersion of a query or multiple queries.
dotplot | dotplot
dotplot-method | dotplot

## -- E --

edit-method | Annotation functionality
encoding | Get and set encoding.
encoding-method | Get and set encoding.
encoding<- | Get and set encoding.
encodings | Conversion between corpus and native encoding.
enrich | Enrich an object.
enrich-method | Context class.
enrich-method | Enrich an object.
enrich-method | S4 kwic class
enrich-method | Bundle of partitions (partition_bundle class).
enrich-method | Partition class and methods.
export | Partition class and methods.
export-method | Partition class and methods.

## -- F --

features | Get features by comparison.
features-class | Feature selection by comparison.
features-method | Get features by comparison.
features_bundle-class | Feature selection by comparison.
features_cooccurrences-class | Feature selection by comparison.
features_ngrams-class | Feature selection by comparison.
flatten | Bundle of partitions (partition_bundle class).
format-method | Cooccurrences class.
format-method | Feature selection by comparison.
format-method | S4 kwic class
format-method | S4 textstat superclass.

## -- G --

getEncoding | Renamed Functions
getTemplate | Renamed Functions
getTerms | Renamed Functions
getTokenStream | Renamed Functions
get_corpus | Corpus class initialization
get_corpus-method | Bundle Class
get_corpus-method | Corpus class methods
get_corpus-method | S4 kwic class
get_corpus-method | The S4 subcorpus class.
get_corpus-method | S4 textstat superclass.
get_info | Generic methods defined in the polmineR package
get_info-method | Corpus class methods
get_template | Get and set templates.
get_template-method | Get and set templates.
get_token_stream | Get Token Stream.
get_token_stream-method | Get Token Stream.
get_type | Get corpus/partition type.
get_type-method | Get corpus/partition type.

## -- H --

head-method | Context class.
head-method | S4 textstat superclass.
highlight | Highlight tokens in text output.
highlight-method | Highlight tokens in text output.
hist-method | Count class.
hits | Get hits for query
hits-class | Hits class.
hits-method | Get hits for query
hits_class | Hits class.
html | Generate html from object.
html-method | Generate html from object.

## -- I --

is.cqp | Tools for CQP queries.
is.partition | Partition class and methods.

## -- K --

knit_print-method | S4 kwic class
knit_print-method | S4 textstat superclass.
kwic | Perform keyword-in-context (KWIC) analysis.
kwic-class | S4 kwic class
kwic-method | Cooccurrences class for corpus/partition.
kwic-method | Perform keyword-in-context (KWIC) analysis.
kwic_bundle-class | Feature selection by comparison.

## -- L --

length-method | Bundle Class
length-method | Context class.
length-method | Count class.
length-method | S4 kwic class
ll | Compute Log-likelihood Statistics.
ll-method | Compute Log-likelihood Statistics.

## -- M --

mail | Send the result of an analysis by Email.
mail-method | Send the result of an analysis by Email.
means | calculate means
means-method | calculate means
merge-method | S4 kwic class
merge-method | Bundle of partitions (partition_bundle class).

## -- N --

name | S4 textstat superclass.
name-method | Corpus class methods
name-method | S4 textstat superclass.
name<- | S4 textstat superclass.
name<--method | Bundle Class
name<--method | The S4 subcorpus class.
name<--method | S4 textstat superclass.
names-method | Bundle Class
names-method | Bundle of partitions (partition_bundle class).
names-method | S4 textstat superclass.
names<--method | Bundle Class
ncol-method | S4 textstat superclass.
ngrams | Get N-Grams
ngrams-class | Ngrams class.
ngrams-method | Get N-Grams
ngrams_class | Ngrams class.
noise | detect noise
noise-method | detect noise
nrow-method | S4 textstat superclass.

## -- O --

ocpu_exec | Execute code on OpenCPU server
opencpu | Execute code on OpenCPU server

## -- P --

partition | Initialize a partition.
partition-class | Partition class and methods.
partition-method | Initialize a partition.
partitionBundle | Renamed Functions
partition_bundle | Generate bundle of partitions.
partition_bundle-class | Bundle of partitions (partition_bundle class).
partition_bundle-method | Bundle of partitions (partition_bundle class).
partition_bundle-method | Generate bundle of partitions.
partition_class | Partition class and methods.
partition_to_string | Decode as String.
pAttributes | Renamed Functions
plpr_partition-class | Partition class and methods.
plpr_subcorpus-class | The S4 subcorpus class.
pmi | Calculate Pointwise Mutual Information (PMI).
pmi-method | Calculate Pointwise Mutual Information (PMI).
polmineR | polmineR-package
polmineR-defunct | Defunct methods and functions.
polmineR-generics | Generic methods defined in the polmineR package
press_partition-class | Partition class and methods.
press_subcorpus-class | The S4 subcorpus class.
punctuation | trim an object
p_attributes | Get p-attributes.
p_attributes-method | Context class.
p_attributes-method | Get p-attributes.
p_attributes-method | Partition class and methods.
p_attributes-method | S4 textstat superclass.

## -- R --

read | Display full text.
read-method | Display full text.
regions | Regions of a CWB corpus.
regions-class | Regions of a CWB corpus.
registry | Get registry and data directories.
registry_get_encoding | Evaluate registry file.
registry_get_home | Evaluate registry file.
registry_get_id | Evaluate registry file.
registry_get_info | Evaluate registry file.
registry_get_name | Evaluate registry file.
registry_get_properties | Evaluate registry file.
registry_get_p_attributes | Evaluate registry file.
registry_get_s_attributes | Evaluate registry file.
registry_move | Get registry and data directories.
registry_reset | Reset registry directory.
remote_corpus | Corpus class initialization
remote_corpus-class | Corpus class initialization
remote_partition-class | Partition class and methods.
remote_subcorpus-class | The S4 subcorpus class.
renamed | Renamed Functions
round-method | S4 textstat superclass.
rownames-method | S4 textstat superclass.

## -- S --

sample-method | Bundle Class
sample-method | Context class.
sample-method | Hits class.
sample-method | S4 kwic class
sAttributes | Renamed Functions
setTemplate | Renamed Functions
set_template | Get and set templates.
set_template-method | Get and set templates.
show-method | Context class.
show-method | S4 context_bundle class
show-method | Cooccurrences class.
show-method | Corpus class methods
show-method | Feature selection by comparison.
show-method | Generate html from object.
show-method | S4 kwic class
show-method | Bundle of partitions (partition_bundle class).
show-method | Partition class and methods.
show-method | Bundled subcorpora
show-method | S4 textstat superclass.
show_info | Generic methods defined in the polmineR package
show_info-method | Corpus class methods
size | Get Number of Tokens.
size-method | Get Number of Tokens.
size-method | The S4 subcorpus class.
slice | Virtual class slice.
slice-class | Virtual class slice.
sort-method | S4 textstat superclass.
split | Partition class and methods.
split-method | Partition class and methods.
split-method | Bundled subcorpora
store | Store objects as Excel-file.
store-method | Store objects as Excel-file.
subcorpus | The S4 subcorpus class.
subcorpus-class | The S4 subcorpus class.
subcorpus_bundle-class | Bundled subcorpora
subset | Subsetting corpora and subcorpora
subset-method | Cooccurrences class for corpus/partition.
subset-method | Bundle Class
subset-method | S4 kwic class
subset-method | Subsetting corpora and subcorpora
subset-method | S4 textstat superclass.
summary-method | Context class.
summary-method | S4 context_bundle class
summary-method | Count class.
summary-method | Feature selection by comparison.
summary-method | Bundle of partitions (partition_bundle class).
summary-method | The S4 subcorpus class.
s_attributes | Get s-attributes.
s_attributes-method | Bundle of partitions (partition_bundle class).
s_attributes-method | Get s-attributes.

## -- T --

tail-method | S4 textstat superclass.
terms | Get terms in 'partition' or corpus.
terms-method | Get terms in 'partition' or corpus.
textstat-class | S4 textstat superclass.
tooltips | Add tooltips to text output.
tooltips-method | Add tooltips to text output.
trim | trim an object
trim-method | Context class.
trim-method | trim an object
t_test | Perform t-test.
t_test-method | Perform t-test.

## -- U --

unique-method | Bundle Class
use | Add corpora in R data packages to session registry.

## -- V --

view | Inspect object using View().
view-method | Cooccurrences class.
view-method | Feature selection by comparison.
view-method | S4 kwic class
view-method | S4 textstat superclass.

## -- W --

weigh | Apply Weight to Matrix
weigh-method | Apply Weight to Matrix

## -- Z --

zoom | Corpus class initialization

## -- misc --

$-method | Bundle Class
$-method | Corpus class methods
$<--method | Bundle Class
+-method | Bundle Class
+-method | Bundle of partitions (partition_bundle class).
+-method | S4 textstat superclass.
[-method | Context class.
[-method | S4 context_bundle class
[-method | S4 kwic class
[-method | Bundle of partitions (partition_bundle class).
[-method | Partition class and methods.
[-method | S4 textstat superclass.
[[-method | Bundle Class
[[-method | Context class.
[[-method | S4 context_bundle class
[[-method | Bundle of partitions (partition_bundle class).
[[-method | S4 textstat superclass.
[[<--method | Bundle Class