forked from PolMine/RcppCWB
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
231 lines (210 loc) · 15.1 KB
/
index.html
File metadata and controls
231 lines (210 loc) · 15.1 KB
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Function reference • RcppCWB</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Function reference"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
<div class="container template-reference-index">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">RcppCWB</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.6.0</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu"><li>
<a href="../articles/vignette.html">Writing performance code with RcppCWB</a>
</li>
</ul></li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://github.com/PolMine/RcppCWB/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="contents col-md-9">
<div class="page-header">
<h1>Reference</h1>
</div>
<table class="ref-index"><colgroup><col class="alias"><col class="title"></colgroup><tbody><tr><th colspan="2">
<h2 id="all-functions">All functions <a href="#all-functions" class="anchor" aria-hidden="true"></a></h2>
<p class="section-desc"></p>
</th>
</tr></tbody><tbody><tr><td>
<p><code><a href="RcppCWB-packge.html">RcppCWB-package</a></code> <code><a href="RcppCWB-packge.html">RcppCWB</a></code> </p>
</td>
<td><p>Rcpp Bindings for the Corpus Workbench (CWB).</p></td>
</tr><tr><td>
<p><code><a href="check_pkg_registry_files.html">check_pkg_registry_files()</a></code> </p>
</td>
<td><p>Check Paths in Registry Files</p></td>
</tr><tr><td>
<p><code><a href="checks.html">check_registry()</a></code> <code><a href="checks.html">check_corpus()</a></code> <code><a href="checks.html">check_s_attribute()</a></code> <code><a href="checks.html">check_p_attribute()</a></code> <code><a href="checks.html">check_strucs()</a></code> <code><a href="checks.html">check_region_matrix()</a></code> <code><a href="checks.html">check_query()</a></code> <code><a href="checks.html">check_cpos()</a></code> <code><a href="checks.html">check_id()</a></code> </p>
</td>
<td><p>Check Input to Rcpp Functions.</p></td>
</tr><tr><td>
<p><code><a href="cl_attribute_size.html">cl_attribute_size()</a></code> </p>
</td>
<td><p>Get Attribute Size (of Positional/Structural Attribute).</p></td>
</tr><tr><td>
<p><code><a href="cl_charset_name.html">cl_charset_name()</a></code> </p>
</td>
<td><p>Get charset of a corpus.</p></td>
</tr><tr><td>
<p><code><a href="cl_delete_corpus.html">cl_delete_corpus()</a></code> </p>
</td>
<td><p>Drop loaded corpus.</p></td>
</tr><tr><td>
<p><code><a href="cl_find_corpus.html">cl_find_corpus()</a></code> </p>
</td>
<td><p>Load corpus.</p></td>
</tr><tr><td>
<p><code><a href="cl_functions.html">attribute_size()</a></code> <code><a href="cl_functions.html">cpos2str()</a></code> <code><a href="cl_functions.html">cpos2id()</a></code> <code><a href="cl_functions.html">struc2cpos()</a></code> <code><a href="cl_functions.html">id2str()</a></code> </p>
</td>
<td><p>Rcpp wrappers for CWB Corpus Library functions</p></td>
</tr><tr><td>
<p><code><a href="cl_lexicon_size.html">cl_lexicon_size()</a></code> </p>
</td>
<td><p>Get Lexicon Size.</p></td>
</tr><tr><td>
<p><code><a href="cl_list_corpora.html">cl_list_corpora()</a></code> </p>
</td>
<td><p>Show CL corpora</p></td>
</tr><tr><td>
<p><code><a href="cl_load_corpus.html">cl_load_corpus()</a></code> </p>
</td>
<td><p>Load corpus</p></td>
</tr><tr><td>
<p><code><a href="cl_rework.html">s_attr()</a></code> <code><a href="cl_rework.html">p_attr()</a></code> <code><a href="cl_rework.html">p_attr_size()</a></code> <code><a href="cl_rework.html">s_attr_size()</a></code> <code><a href="cl_rework.html">p_attr_lexicon_size()</a></code> <code><a href="cl_rework.html">cpos_to_struc()</a></code> <code><a href="cl_rework.html">cpos_to_str()</a></code> <code><a href="cl_rework.html">cpos_to_id()</a></code> <code><a href="cl_rework.html">struc_to_cpos()</a></code> <code><a href="cl_rework.html">struc_to_str()</a></code> <code><a href="cl_rework.html">regex_to_id()</a></code> <code><a href="cl_rework.html">str_to_id()</a></code> <code><a href="cl_rework.html">id_to_freq()</a></code> <code><a href="cl_rework.html">id_to_cpos()</a></code> <code><a href="cl_rework.html">cpos_to_lbound()</a></code> <code><a href="cl_rework.html">cpos_to_rbound()</a></code> </p>
</td>
<td><p>Low-level CL access.</p></td>
</tr><tr><td>
<p><code><a href="cl_struc_values.html">cl_struc_values()</a></code> </p>
</td>
<td><p>Check whether structural attribute has values</p></td>
</tr><tr><td>
<p><code><a href="corpus_is_loaded.html">corpus_is_loaded()</a></code> </p>
</td>
<td><p>Check whether corpus is loaded</p></td>
</tr><tr><td>
<p><code><a href="cqp_initialize.html">cqp_initialize()</a></code> <code><a href="cqp_initialize.html">cqp_is_initialized()</a></code> <code><a href="cqp_initialize.html">cqp_verbosity()</a></code> <code><a href="cqp_initialize.html">cqp_get_registry()</a></code> <code><a href="cqp_initialize.html">cqp_reset_registry()</a></code> <code><a href="cqp_initialize.html">cqp_load_corpus()</a></code> </p>
</td>
<td><p>Initialize Corpus Query Processor (CQP).</p></td>
</tr><tr><td>
<p><code><a href="cqp_list_corpora.html">cqp_list_corpora()</a></code> </p>
</td>
<td><p>List Available CWB Corpora.</p></td>
</tr><tr><td>
<p><code><a href="cqp_query.html">cqp_query()</a></code> <code><a href="cqp_query.html">cqp_dump_subcorpus()</a></code> <code><a href="cqp_query.html">cqp_subcorpus_size()</a></code> <code><a href="cqp_query.html">cqp_list_subcorpora()</a></code> <code><a href="cqp_query.html">cqp_drop_subcorpus()</a></code> </p>
</td>
<td><p>Execute CQP Query and Retrieve Results.</p></td>
</tr><tr><td>
<p><code><a href="cwb_charsets.html">cwb_charsets()</a></code> </p>
</td>
<td><p>Character sets supported by CWB</p></td>
</tr><tr><td>
<p><code><a href="cwb_utils.html">cwb_makeall()</a></code> <code><a href="cwb_utils.html">cwb_huffcode()</a></code> <code><a href="cwb_utils.html">cwb_compress_rdx()</a></code> <code><a href="cwb_utils.html">cwb_encode()</a></code> </p>
</td>
<td><p>CWB Tools for Creating Corpora</p></td>
</tr><tr><td>
<p><code><a href="cwb_version.html">cwb_version()</a></code> </p>
</td>
<td><p>Get CWB version</p></td>
</tr><tr><td>
<p><code><a href="get_cbow_matrix.html">get_cbow_matrix()</a></code> </p>
</td>
<td><p>Get CBOW Matrix.</p></td>
</tr><tr><td>
<p><code><a href="get_count_vector.html">get_count_vector()</a></code> </p>
</td>
<td><p>Get Vector with Counts for Positional Attribute.</p></td>
</tr><tr><td>
<p><code><a href="get_pkg_registry.html">get_pkg_registry()</a></code> </p>
</td>
<td><p>Get Registry Directory Within Package</p></td>
</tr><tr><td>
<p><code><a href="get_region_matrix.html">get_region_matrix()</a></code> </p>
</td>
<td><p>Get Matrix with Regions for Strucs.</p></td>
</tr><tr><td>
<p><code><a href="ids_to_count_matrix.html">ids_to_count_matrix()</a></code> </p>
</td>
<td><p>Perform Count for Vector of IDs.</p></td>
</tr><tr><td>
<p><code><a href="matrix_to_subcorpus.html">matrix_to_subcorpus()</a></code> </p>
</td>
<td><p>Create CWB subcorpus from matrix with regions.</p></td>
</tr><tr><td>
<p><code><a href="p_attr_default.html">p_attr_default()</a></code> </p>
</td>
<td><p>Get default p-attribute</p></td>
</tr><tr><td>
<p><code><a href="p_attributes.html">cl_cpos2str()</a></code> <code><a href="p_attributes.html">cl_cpos2id()</a></code> <code><a href="p_attributes.html">cl_id2str()</a></code> <code><a href="p_attributes.html">cl_regex2id()</a></code> <code><a href="p_attributes.html">cl_str2id()</a></code> <code><a href="p_attributes.html">cl_id2freq()</a></code> <code><a href="p_attributes.html">cl_id2cpos()</a></code> </p>
</td>
<td><p>Using Positional Attributes.</p></td>
</tr><tr><td>
<p><code><a href="region_matrix_ops.html">region_matrix_to_ids()</a></code> <code><a href="region_matrix_ops.html">region_matrix_to_count_matrix()</a></code> <code><a href="region_matrix_ops.html">region_matrix_context()</a></code> <code><a href="region_matrix_ops.html">ranges_to_cpos()</a></code> </p>
</td>
<td><p>Get IDs and Counts for Region Matrices.</p></td>
</tr><tr><td>
<p><code><a href="registry_info.html">corpus_data_dir()</a></code> <code><a href="registry_info.html">corpus_info_file()</a></code> <code><a href="registry_info.html">corpus_full_name()</a></code> <code><a href="registry_info.html">corpus_p_attributes()</a></code> <code><a href="registry_info.html">corpus_s_attributes()</a></code> <code><a href="registry_info.html">corpus_properties()</a></code> <code><a href="registry_info.html">corpus_property()</a></code> <code><a href="registry_info.html">corpus_registry_dir()</a></code> </p>
</td>
<td><p>Get information from registry file</p></td>
</tr><tr><td>
<p><code><a href="s_attr_regions.html">s_attr_regions()</a></code> </p>
</td>
<td><p>Get regions defined by a structural attribute</p></td>
</tr><tr><td>
<p><code><a href="s_attribute_decode.html">s_attribute_decode()</a></code> </p>
</td>
<td><p>Decode Structural Attribute.</p></td>
</tr><tr><td>
<p><code><a href="s_attributes.html">cl_cpos2struc()</a></code> <code><a href="s_attributes.html">cl_struc2cpos()</a></code> <code><a href="s_attributes.html">cl_struc2str()</a></code> <code><a href="s_attributes.html">cl_cpos2lbound()</a></code> <code><a href="s_attributes.html">cl_cpos2rbound()</a></code> </p>
</td>
<td><p>Using Structural Attributes.</p></td>
</tr><tr><td>
<p><code><a href="subcorpus_get_ranges.html">subcorpus_get_ranges()</a></code> </p>
</td>
<td><p>Get ranges of subcorpus</p></td>
</tr><tr><td>
<p><code><a href="tmp_registry.html">use_tmp_registry()</a></code> <code><a href="tmp_registry.html">get_tmp_registry()</a></code> </p>
</td>
<td><p>Use Temporary Registry</p></td>
</tr><tr><td>
<p><code><a href="xml.html">s_attr_is_descendent()</a></code> <code><a href="xml.html">s_attr_is_sibling()</a></code> <code><a href="xml.html">s_attr_relationship()</a></code> </p>
</td>
<td><p>Explore XML structure of CWB corpus</p></td>
</tr></tbody></table></div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Andreas Blaette, Bernard Desgraupes, Sylvain Loiseau.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
</div>
</footer></div>
</body></html>