forked from PolMine/RcppCWB
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy paths_attributes.html
More file actions
209 lines (177 loc) · 17.8 KB
/
s_attributes.html
File metadata and controls
209 lines (177 loc) · 17.8 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
<!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>Using Structural Attributes. — CL: s_attributes • 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="Using Structural Attributes. — CL: s_attributes"><meta property="og:description" content="Structural attributes store the metadata of texts in a CWB
corpus and/or any kind of annotation of a region of text. The fundamental
unit are so-called strucs, i.e. indices of regions identified by a left and
a right corpus position. The corpus library (CL) offers a set of functions
to make the translations between corpus positions (cpos) and strucs
(struc)."><!-- 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>Using Structural Attributes.</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>s_attributes.Rd</code></div>
</div>
<div class="ref-description">
<p>Structural attributes store the metadata of texts in a CWB
corpus and/or any kind of annotation of a region of text. The fundamental
unit are so-called strucs, i.e. indices of regions identified by a left and
a right corpus position. The corpus library (CL) offers a set of functions
to make the translations between corpus positions (cpos) and strucs
(struc).</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">cl_cpos2struc</span><span class="op">(</span></span>
<span> <span class="va">corpus</span>,</span>
<span> <span class="va">s_attribute</span>,</span>
<span> <span class="va">cpos</span>,</span>
<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>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cl_struc2cpos</span><span class="op">(</span></span>
<span> <span class="va">corpus</span>,</span>
<span> <span class="va">s_attribute</span>,</span>
<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>
<span> <span class="va">struc</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cl_struc2str</span><span class="op">(</span></span>
<span> <span class="va">corpus</span>,</span>
<span> <span class="va">s_attribute</span>,</span>
<span> <span class="va">struc</span>,</span>
<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>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cl_cpos2lbound</span><span class="op">(</span></span>
<span> <span class="va">corpus</span>,</span>
<span> <span class="va">s_attribute</span>,</span>
<span> <span class="va">cpos</span>,</span>
<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>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">cl_cpos2rbound</span><span class="op">(</span></span>
<span> <span class="va">corpus</span>,</span>
<span> <span class="va">s_attribute</span>,</span>
<span> <span class="va">cpos</span>,</span>
<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>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>corpus</dt>
<dd><p>name of a CWB corpus (upper case)</p></dd>
<dt>s_attribute</dt>
<dd><p>name of structural attribute (character vector)</p></dd>
<dt>cpos</dt>
<dd><p>An <code>integer</code> vector with corpus positions.</p></dd>
<dt>registry</dt>
<dd><p>path to the registry directory, defaults to the value of the
environment variable CORPUS_REGISTRY</p></dd>
<dt>struc</dt>
<dd><p>a struc identifying a region</p></dd>
</dl></div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># get metadata for matches of token</span></span></span>
<span class="r-in"><span><span class="co"># scenario: id of the texts with occurrence of 'oil'</span></span></span>
<span class="r-in"><span><span class="va">token_to_get</span> <span class="op"><-</span> <span class="st">"oil"</span></span></span>
<span class="r-in"><span><span class="va">token_id</span> <span class="op"><-</span> <span class="fu"><a href="p_attributes.html">cl_str2id</a></span><span class="op">(</span><span class="st">"REUTERS"</span>, p_attribute <span class="op">=</span> <span class="st">"word"</span>, str <span class="op">=</span> <span class="st">"oil"</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-in"><span><span class="va">token_cpos</span> <span class="op"><-</span> <span class="fu"><a href="p_attributes.html">cl_id2cpos</a></span><span class="op">(</span><span class="st">"REUTERS"</span>, p_attribute <span class="op">=</span> <span class="st">"word"</span>, id <span class="op">=</span> <span class="va">token_id</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-in"><span><span class="va">strucs</span> <span class="op"><-</span> <span class="fu">cl_cpos2struc</span><span class="op">(</span><span class="st">"REUTERS"</span>, s_attribute <span class="op">=</span> <span class="st">"id"</span>, cpos <span class="op">=</span> <span class="va">token_cpos</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-in"><span><span class="va">strucs_unique</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/unique.html" class="external-link">unique</a></span><span class="op">(</span><span class="va">strucs</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">text_ids</span> <span class="op"><-</span> <span class="fu">cl_struc2str</span><span class="op">(</span><span class="st">"REUTERS"</span>, s_attribute <span class="op">=</span> <span class="st">"id"</span>, struc <span class="op">=</span> <span class="va">strucs_unique</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-in"><span></span></span>
<span class="r-in"><span><span class="co"># get the full text of the first text with match for 'oil'</span></span></span>
<span class="r-in"><span><span class="va">left_cpos</span> <span class="op"><-</span> <span class="fu">cl_cpos2lbound</span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"REUTERS"</span>, s_attribute <span class="op">=</span> <span class="st">"id"</span>,</span></span>
<span class="r-in"><span> cpos <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Extremes.html" class="external-link">min</a></span><span class="op">(</span><span class="va">token_cpos</span><span class="op">)</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><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">right_cpos</span> <span class="op"><-</span> <span class="fu">cl_cpos2rbound</span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"REUTERS"</span>,</span></span>
<span class="r-in"><span> s_attribute <span class="op">=</span> <span class="st">"id"</span>,</span></span>
<span class="r-in"><span> cpos <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Extremes.html" class="external-link">min</a></span><span class="op">(</span><span class="va">token_cpos</span><span class="op">)</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><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">txt</span> <span class="op"><-</span> <span class="fu"><a href="p_attributes.html">cl_cpos2str</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"REUTERS"</span>, p_attribute <span class="op">=</span> <span class="st">"word"</span>,</span></span>
<span class="r-in"><span> cpos <span class="op">=</span> <span class="va">left_cpos</span><span class="op">:</span><span class="va">right_cpos</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><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">fulltext</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste</a></span><span class="op">(</span><span class="va">txt</span>, collapse <span class="op">=</span> <span class="st">" "</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># alternativ approach to achieve same result</span></span></span>
<span class="r-in"><span><span class="va">first_struc_match_oil</span> <span class="op"><-</span> <span class="fu">cl_cpos2struc</span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"REUTERS"</span>, s_attribute <span class="op">=</span> <span class="st">"id"</span>,</span></span>
<span class="r-in"><span> cpos <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Extremes.html" class="external-link">min</a></span><span class="op">(</span><span class="va">token_cpos</span><span class="op">)</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> <span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">cpos_struc</span> <span class="op"><-</span> <span class="fu">cl_struc2cpos</span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"REUTERS"</span>, s_attribute <span class="op">=</span> <span class="st">"id"</span>,</span></span>
<span class="r-in"><span> struc <span class="op">=</span> <span class="va">first_struc_match_oil</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><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">txt</span> <span class="op"><-</span> <span class="fu"><a href="p_attributes.html">cl_cpos2str</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"REUTERS"</span>,</span></span>
<span class="r-in"><span> p_attribute <span class="op">=</span> <span class="st">"word"</span>,</span></span>
<span class="r-in"><span> cpos <span class="op">=</span> <span class="va">cpos_struc</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span><span class="op">:</span><span class="va">cpos_struc</span><span class="op">[</span><span class="fl">2</span><span class="op">]</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><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">fulltext</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste</a></span><span class="op">(</span><span class="va">txt</span>, collapse <span class="op">=</span> <span class="st">" "</span><span class="op">)</span></span></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>