forked from PolMine/RcppCWB
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathchecks.Rd
More file actions
77 lines (59 loc) · 1.72 KB
/
Copy pathchecks.Rd
File metadata and controls
77 lines (59 loc) · 1.72 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/checks.R
\name{check}
\alias{check}
\alias{check_registry}
\alias{check_corpus}
\alias{check_s_attribute}
\alias{check_p_attribute}
\alias{check_strucs}
\alias{check_region_matrix}
\alias{check_query}
\alias{check_cpos}
\alias{check_id}
\title{Check Input to Rcpp Functions.}
\usage{
check_registry(registry)
check_corpus(corpus, registry, cl = TRUE, cqp = TRUE)
check_s_attribute(
s_attribute,
corpus,
registry = Sys.getenv("CORPUS_REGISTRY")
)
check_p_attribute(
p_attribute,
corpus,
registry = Sys.getenv("CORPUS_REGISTRY")
)
check_strucs(corpus, s_attribute, strucs, registry)
check_region_matrix(region_matrix)
check_query(query)
check_cpos(
corpus,
p_attribute = "word",
cpos,
registry = Sys.getenv("CORPUS_REGISTRY")
)
check_id(corpus, p_attribute, id, registry = Sys.getenv("CORPUS_REGISTRY"))
}
\arguments{
\item{registry}{path to registry directory}
\item{corpus}{name of a CWB corpus}
\item{cl}{A \code{logical} value, whether CL availability of corpus is required
for positive result.}
\item{cqp}{A \code{logical} value, whether CQP availability of corpus is required
for positive result.}
\item{s_attribute}{a structural attribute}
\item{p_attribute}{a positional attribute}
\item{strucs}{strucs (indices of structural attributes)}
\item{region_matrix}{a region matrix}
\item{query}{a CQP query}
\item{cpos}{vector of corpus positions}
\item{id}{id (encoded p-attribute), integer value}
}
\description{
A set of functions to check whether the input values to the Rcpp
wrappers for the C functions of the Corpus Workbench potentially causing
crashes are valid. These auxiliary functions are called by the cl_ and cqp_
functions.
}