/
_pkgdown.yml
117 lines (117 loc) · 3.92 KB
/
_pkgdown.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
template:
params:
bootswatch: cerulean
reference:
- title: "Package Basics"
desc: Getting started with polmineR (CLI And GUI usage).
contents:
- polmineR
- polmineR-generics
- title: "Corpora and subcorpora"
desc: Corpora, subcorpora/partitions, and partition_bundle objects are the point of departure for any analysis using polmineR. Constructors introduced in the next section require an understanding of basic methods and classes to generate and manage (sub-)corpora
contents:
- use
- corpus
- corpus-class
- corpus-methods
- subset
- ocpu_exec
- slice
- partition
- partition_bundle
- p_attributes
- s_attributes
- as.speeches
- subcorpus-class
- subcorpus_bundle-class
- regions
- title: "Methods I: Basic Vocabulary"
desc: Data analysis using polmineR will usually start by calling a constructor method resulting in an S4 class object with the name of the calling method. All methods basic vocabulary can be applied to corpora (defined by a character vector), to partitions, and to partition_bundle objects, some are applicable to additional classes. These methods are designed to be used in a pipe.
contents:
- kwic
- hits
- count
- dispersion
- ngrams
- context
- cooccurrences
- features
- phrases
- title: "Methods II: Processing Objects"
desc: The polmineR package offers a repertoire to modify base objects, and for type conversion. Methods for modyfing classes and type conversion.
contents:
- size
- terms
- enrich
- trim
- noise
- encoding
- as.TermDocumentMatrix
- as.sparseMatrix
- as.VCorpus
- chisquare
- ll
- t_test
- pmi
- means
- weigh
- mail
- dotplot
- restore
- title: "Methods III: Fulltext Output"
desc: A key consideration of polmineR is to combine quantitative and qualitative steps of analysis in a workflow. A set of methods is exposed to generate and enhance fulltext output.
contents:
- read
- html
- annotations
- as.markdown
- browse
- view
- highlight
- tooltips
- get_template
- get_type
- partition_to_string
- title: "The 'textstat' Class & Childs"
desc: The main feature of the textstat class and of classes inheriting from it is that it keeps statistical information about a corpus or partition in a data.table in the field 'stat'. Methods defined for the textstat superclass are available for its child classes, unless they are overloaded in a specified manner.
contents:
- textstat-class
- count_class
- ngrams_class
- partition_class
- hits_class
- context-class
- cooccurrences-class
- Cooccurrences-class
- Cooccurrences,character-method
- features-class
- title: "The 'kwic' & 'Labels' Classes"
desc: xxx
contents:
- kwic-class
- title: "The 'bundle' Class & Childs"
desc: S4 classes for managing text analysis.
contents:
- bundle-class
- partition_bundle-class
- context_bundle-class
- blapply
- title: "Low-level CWB Access"
desc: The API used to access CWB indexed corpora is the RcppCWB package. A set of functions in the polmineR package serves as an intermediate interface to access corpus data.
contents:
- registry
- registry_reset
- registry_get_name
- cpos
- get_token_stream
- decode
- cqp
- title: "Utility Functions"
desc: Exported utility functions / helpers.
contents:
- encodings
- store
- title: "Backwards Compatibility"
desc: Starting with v0.7.9, the coding style of the polmineR-package has moved from camelCase to snake_case. A set of 'old style'-functions ensures backwards compatibility and that old code will not break.
contents:
- renamed