forked from PolMine/RcppCWB
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathregistry_info.html
More file actions
174 lines (146 loc) · 14.7 KB
/
registry_info.html
File metadata and controls
174 lines (146 loc) · 14.7 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
<!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>Get information from registry file — corpus_data_dir • 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="Get information from registry file — corpus_data_dir"><meta property="og:description" content="Extract information from the internal C representation of registry data."><!-- 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>Get information from registry file</h1>
<small class="dont-index">Source: <a href="https://github.com/PolMine/RcppCWB/blob/HEAD/R/cl.R" class="external-link"><code>R/cl.R</code></a></small>
<div class="hidden name"><code>registry_info.Rd</code></div>
</div>
<div class="ref-description">
<p>Extract information from the internal C representation of registry data.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">corpus_data_dir</span><span class="op">(</span><span class="va">corpus</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">corpus_info_file</span><span class="op">(</span><span class="va">corpus</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">corpus_full_name</span><span class="op">(</span><span class="va">corpus</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">corpus_p_attributes</span><span class="op">(</span><span class="va">corpus</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">corpus_s_attributes</span><span class="op">(</span><span class="va">corpus</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">corpus_properties</span><span class="op">(</span><span class="va">corpus</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">corpus_property</span><span class="op">(</span><span class="va">corpus</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="va">property</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">corpus_registry_dir</span><span class="op">(</span><span class="va">corpus</span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>corpus</dt>
<dd><p>A length-one <code>character</code> vector with the corpus ID.</p></dd>
<dt>registry</dt>
<dd><p>A length-one <code>character</code> vector with the registry directory.</p></dd>
<dt>property</dt>
<dd><p>A corpus property defined in the registry file (.</p></dd>
</dl></div>
<div id="details">
<h2>Details</h2>
<p><code>corpus_data_dir()</code> will return the data directory (class <code>fs_path</code>)
where the binary files of a corpus are kept (a directory also known as
'home' directory).</p>
<p><code>corpus_info_file()</code> will return the path to the info file for a
corpus (class <code>fs_path</code> object). If info file does not exist or INFO line
is missing in the registry file, <code>NA</code> is returned.</p>
<p><code>corpus_full_name()</code> will return the full name of the corpus defined
in the registry file.</p>
<p><code>corpus_p_attributes()</code> returns a <code>character</code> vector with the
positional attributes of a corpus.</p>
<p><code>corpus_s_attributes()</code> returns a <code>character</code> vector with the
structural attributes of a corpus.</p>
<p><code>corpus_properties()</code> returns a <code>character</code> vector with the corpus
properties defined in the registry file. If the corpus cannot be located,
<code>NA</code> is returned.</p>
<p><code>corpus_property()</code> returns the value of a corpus property defined
in the registry file, or <code>NA</code> if the corpus does not exist, is not loaded
of if the property requested is undefined.</p>
<p><code>corpus_get_registry()</code> will extract the registry directory with the
registry file defining a corpus from the internal C representation of
loaded corpora. The <code>character</code> vector that is returned may be > 1 if there
are several corpora with the same id defined in registry files in different
(registry) directories. If the corpus is not found, <code>NA</code> is returned.</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">corpus_data_dir</span><span class="op">(</span><span class="st">"REUTERS"</span>, registry <span class="op">=</span> <span class="fu"><a href="tmp_registry.html">get_tmp_registry</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #0000BB; font-weight: bold;">/private/var/folders/fw/qwt11pjx1qs83dl2jwltcvmr0000gn/T/RtmpKoAgt6/temp_libpath4845763841bb/RcppCWB/extdata/cwb/indexed_corpora/reuters</span></span>
<span class="r-in"><span><span class="fu">corpus_info_file</span><span class="op">(</span><span class="st">"REUTERS"</span>, registry <span class="op">=</span> <span class="fu"><a href="tmp_registry.html">get_tmp_registry</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> /private/var/folders/fw/qwt11pjx1qs83dl2jwltcvmr0000gn/T/RtmpKoAgt6/temp_libpath4845763841bb/RcppCWB/extdata/cwb/indexed_corpora/reuters/info.md</span>
<span class="r-in"><span><span class="fu">corpus_full_name</span><span class="op">(</span><span class="st">"REUTERS"</span>, registry <span class="op">=</span> <span class="fu"><a href="tmp_registry.html">get_tmp_registry</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] "Reuters Sample Corpus"</span>
<span class="r-in"><span><span class="fu">corpus_p_attributes</span><span class="op">(</span><span class="st">"REUTERS"</span>, registry <span class="op">=</span> <span class="fu"><a href="tmp_registry.html">get_tmp_registry</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] "word"</span>
<span class="r-in"><span><span class="fu">corpus_s_attributes</span><span class="op">(</span><span class="st">"REUTERS"</span>, registry <span class="op">=</span> <span class="fu"><a href="tmp_registry.html">get_tmp_registry</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] "id" "topics_cat" "places" "language" </span>
<span class="r-in"><span><span class="fu">corpus_properties</span><span class="op">(</span><span class="st">"REUTERS"</span>, registry <span class="op">=</span> <span class="fu"><a href="tmp_registry.html">get_tmp_registry</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] "language" "charset" </span>
<span class="r-in"><span><span class="fu">corpus_property</span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"REUTERS"</span>,</span></span>
<span class="r-in"><span> registry <span class="op">=</span> <span class="fu"><a href="tmp_registry.html">get_tmp_registry</a></span><span class="op">(</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> property <span class="op">=</span> <span class="st">"language"</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] "en"</span>
<span class="r-in"><span><span class="fu">corpus_registry_dir</span><span class="op">(</span><span class="st">"REUTERS"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #0000BB; font-weight: bold;">/private/var/folders/fw/qwt11pjx1qs83dl2jwltcvmr0000gn/T/RtmpKoAgt6/temp_libpath4845763841bb/RcppCWB/extdata/cwb/registry</span></span>
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #0000BB; font-weight: bold;">/var/folders/fw/qwt11pjx1qs83dl2jwltcvmr0000gn/T/Rtmpa5P52q/registry_tmp</span></span>
<span class="r-in"><span><span class="fu">corpus_registry_dir</span><span class="op">(</span><span class="st">"FOO"</span><span class="op">)</span> <span class="co"># NA returned</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] NA</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>