forked from PolMine/RcppCWB
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcqp_initialize.html
More file actions
222 lines (192 loc) · 18.2 KB
/
cqp_initialize.html
File metadata and controls
222 lines (192 loc) · 18.2 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
<!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>Initialize Corpus Query Processor (CQP). — cqp_initialize • 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="Initialize Corpus Query Processor (CQP). — cqp_initialize"><meta property="og:description" content="CQP needs to know where to look for CWB indexed corpora. To initialize CQP,
call cqp_initialize. To reset the registry, use the function
cqp_reset_registry. To get the registry used by CQP, use
cqp_get_registry. To get the initialization status, use
cqp_is_initialized"><!-- 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-topic">
<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="col-md-9 contents">
<div class="page-header">
<h1>Initialize Corpus Query Processor (CQP).</h1>
<small class="dont-index">Source: <a href="https://github.com/PolMine/RcppCWB/blob/HEAD/R/cqp.R" class="external-link"><code>R/cqp.R</code></a></small>
<div class="hidden name"><code>cqp_initialize.Rd</code></div>
</div>
<div class="ref-description">
<p>CQP needs to know where to look for CWB indexed corpora. To initialize CQP,
call <code>cqp_initialize</code>. To reset the registry, use the function
<code>cqp_reset_registry</code>. To get the registry used by CQP, use
<code>cqp_get_registry</code>. To get the initialization status, use
<code>cqp_is_initialized</code></p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">cqp_initialize</span><span class="op">(</span>registry <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.getenv.html" class="external-link">Sys.getenv</a></span><span class="op">(</span><span class="st">"CORPUS_REGISTRY"</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cqp_is_initialized</span><span class="op">(</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cqp_verbosity</span><span class="op">(</span><span class="va">silent</span>, <span class="va">verbose</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cqp_get_registry</span><span class="op">(</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cqp_reset_registry</span><span class="op">(</span>registry <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.getenv.html" class="external-link">Sys.getenv</a></span><span class="op">(</span><span class="st">"CORPUS_REGISTRY"</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cqp_load_corpus</span><span class="op">(</span><span class="va">corpus</span>, <span class="va">registry</span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>registry</dt>
<dd><p>the registry directory</p></dd>
<dt>silent</dt>
<dd><p>A single <code>logical</code> value, whether to be silent and suppress CQP
messages (<code>TRUE</code>), or not (<code>FALSE</code>).</p></dd>
<dt>verbose</dt>
<dd><p>A single <code>logical</code> value, whether to show verbose parser
output (<code>TRUE</code>) or not (<code>FALSE</code>).</p></dd>
<dt>corpus</dt>
<dd><p>ID of a CWB corpus (length-one <code>character</code>).</p></dd>
</dl></div>
<div id="details">
<h2>Details</h2>
<p><code>cqp_load_corpus</code> will return a <code>logical</code> value - <code>TRUE</code> if corpus
has been loaded successfully, <code>FALSE</code> if not.</p>
</div>
<div id="author">
<h2>Author</h2>
<p>Andreas Blaette, Bernard Desgraupes, Sylvain Loiseau</p>
</div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">cqp_is_initialized</span><span class="op">(</span><span class="op">)</span> <span class="co"># check initialization status</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] TRUE</span>
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="op">!</span><span class="fu">cqp_is_initialized</span><span class="op">(</span><span class="op">)</span><span class="op">)</span> <span class="fu">cqp_initialize</span><span class="op">(</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">cqp_is_initialized</span><span class="op">(</span><span class="op">)</span> <span class="co"># check initialization status (TRUE now?)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] TRUE</span>
<span class="r-in"><span><span class="fu">cqp_get_registry</span><span class="op">(</span><span class="op">)</span> <span class="co"># get registry dir used by CQP</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #0000BB; font-weight: bold;">/Users/andreasblatte/Data/cwb/registry</span></span>
<span class="r-in"><span><span class="fu"><a href="cqp_list_corpora.html">cqp_list_corpora</a></span><span class="op">(</span><span class="op">)</span> <span class="co"># get list of corpora</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] "UNGA" "REUTERS" </span>
<span class="r-out co"><span class="r-pr">#></span> [3] "RHLA" "HST" </span>
<span class="r-out co"><span class="r-pr">#></span> [5] "GIAN" "GERMAPARLSAMPLE" </span>
<span class="r-out co"><span class="r-pr">#></span> [7] "MBGA" "PARTYPAGES" </span>
<span class="r-out co"><span class="r-pr">#></span> [9] "MATK" "RZTG" </span>
<span class="r-out co"><span class="r-pr">#></span> [11] "SAAR" "NEUW" </span>
<span class="r-out co"><span class="r-pr">#></span> [13] "BEZE" "NAZT" </span>
<span class="r-out co"><span class="r-pr">#></span> [15] "SOMP" "TA" </span>
<span class="r-out co"><span class="r-pr">#></span> [17] "SWT" "WOAZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [19] "PAZ" "VBW" </span>
<span class="r-out co"><span class="r-pr">#></span> [21] "NGVZ" "MBVS" </span>
<span class="r-out co"><span class="r-pr">#></span> [23] "BKR" "BKU" </span>
<span class="r-out co"><span class="r-pr">#></span> [25] "TZH" "DAW" </span>
<span class="r-out co"><span class="r-pr">#></span> [27] "FNP" "BMP" </span>
<span class="r-out co"><span class="r-pr">#></span> [29] "SWAZ" "MIGPARL" </span>
<span class="r-out co"><span class="r-pr">#></span> [31] "WEST" "GEZE" </span>
<span class="r-out co"><span class="r-pr">#></span> [33] "LBN" "BADZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [35] "GTB" "LR" </span>
<span class="r-out co"><span class="r-pr">#></span> [37] "OHEZ" "NNN" </span>
<span class="r-out co"><span class="r-pr">#></span> [39] "BGM" "HAZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [41] "DNN" "BR" </span>
<span class="r-out co"><span class="r-pr">#></span> [43] "WAZ" "GERMAPARL_PARLACLARIN_III"</span>
<span class="r-out co"><span class="r-pr">#></span> [45] "LAZE" "GERMAPARL" </span>
<span class="r-out co"><span class="r-pr">#></span> [47] "NPHA" "MPW" </span>
<span class="r-out co"><span class="r-pr">#></span> [49] "WBN" "KIRZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [51] "BZ" "WBZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [53] "OSZ" "WEWA" </span>
<span class="r-out co"><span class="r-pr">#></span> [55] "KN" "RELO" </span>
<span class="r-out co"><span class="r-pr">#></span> [57] "MUVB" "HA" </span>
<span class="r-out co"><span class="r-pr">#></span> [59] "KR" "WKR" </span>
<span class="r-out co"><span class="r-pr">#></span> [61] "NOW" "TLZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [63] "NRZ" "MASP" </span>
<span class="r-out co"><span class="r-pr">#></span> [65] "BUER" "MUAZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [67] "KSTA" "ALLZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [69] "OAZ" "OEFA" </span>
<span class="r-out co"><span class="r-pr">#></span> [71] "MUME" "SZO" </span>
<span class="r-out co"><span class="r-pr">#></span> [73] "AAZ" "HIAZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [75] "STAG" "FEPR" </span>
<span class="r-out co"><span class="r-pr">#></span> [77] "NADIRAFAZ" "TV" </span>
<span class="r-out co"><span class="r-pr">#></span> [79] "DECH" "WK" </span>
<span class="r-out co"><span class="r-pr">#></span> [81] "HOFZ" "BVH" </span>
<span class="r-out co"><span class="r-pr">#></span> [83] "MIB" "GERMAPARL2" </span>
<span class="r-out co"><span class="r-pr">#></span> [85] "BEZG" "ALBB" </span>
<span class="r-out co"><span class="r-pr">#></span> [87] "SEGZ" "EXPR" </span>
<span class="r-out co"><span class="r-pr">#></span> [89] "LVZ" "WRU" </span>
<span class="r-out co"><span class="r-pr">#></span> [91] "GEA" "COBU" </span>
<span class="r-out co"><span class="r-pr">#></span> [93] "UNGA" "SWP" </span>
<span class="r-out co"><span class="r-pr">#></span> [95] "RAMOMEDIA_FAZ" "WESP" </span>
<span class="r-out co"><span class="r-pr">#></span> [97] "VZS" "HATA" </span>
<span class="r-out co"><span class="r-pr">#></span> [99] "NADIRATAZ" "DAZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [101] "NNP" "NKU" </span>
<span class="r-out co"><span class="r-pr">#></span> [103] "MAER" "NKR" </span>
<span class="r-out co"><span class="r-pr">#></span> [105] "HNA" "IDZL" </span>
<span class="r-out co"><span class="r-pr">#></span> [107] "SAZE" "BNA" </span>
<span class="r-out co"><span class="r-pr">#></span> [109] "SGZ" "NZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [111] "EZE" "MUZE" </span>
<span class="r-out co"><span class="r-pr">#></span> [113] "LIN" "NN" </span>
<span class="r-out co"><span class="r-pr">#></span> [115] "NOZ" "HOZG" </span>
<span class="r-out co"><span class="r-pr">#></span> [117] "OVZ" "NADIRASZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [119] "RHUN" "RAMOMEDIA_SZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [121] "MZ" "HK" </span>
<span class="r-out co"><span class="r-pr">#></span> [123] "WORZ" "MAZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [125] "SVZ" "PRIG" </span>
<span class="r-out co"><span class="r-pr">#></span> [127] "GAZ" "NWZ" </span>
<span class="r-out co"><span class="r-pr">#></span> [129] "KRAN" "RLNR" </span>
<span class="r-out co"><span class="r-pr">#></span> [131] "DIKI" "GERMAPARL_BETA" </span>
<span class="r-out co"><span class="r-pr">#></span> [133] "FRT" "HAKU" </span>
<span class="r-out co"><span class="r-pr">#></span> [135] "USAN" "MOPO" </span>
<span class="r-out co"><span class="r-pr">#></span> [137] "LAAN" "BRZE" </span>
<span class="r-out co"><span class="r-pr">#></span> [139] "SK" </span>
</code></pre></div>
</div>
</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>