File: readSolrDoc.Rd

package info (click to toggle)
r-cran-xml 3.99-0.19-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,688 kB
  • sloc: ansic: 6,659; xml: 2,890; asm: 486; sh: 12; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 1,141 bytes parent folder | download | duplicates (7)
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
\name{readSolrDoc}
\alias{readSolrDoc}
\alias{readSolrDoc,XMLInternalDocument-method}
\alias{readSolrDoc,XMLInternalNode-method}
\alias{readSolrDoc,character-method}
\alias{readSolrDoc,AsIs-method}

\title{Read the data from a Solr document}
\description{
  Solr documents are used to represent
  general data in a reasonably simple format
  made up of lists, integers, logicals, longs,
  doubles, dates, etc. each with an optional name.
  These correspond very naturally to R objects.
}
\usage{
readSolrDoc(doc, ...)
}
\arguments{
  \item{doc}{the object containing the data. This can be the name of a
    file, a parsed XML document or an XML node.}
  \item{\dots}{additional parameters for the methods.}
}
\value{
  An R object representing the data in the Solr document,
  typically a named vector or named list.
}
\references{
  Lucene text search system.
}
\author{
Duncan Temple Lang
}


\seealso{
  \code{\link{readKeyValueDB}},
    \code{\link{xmlToList}},
  \code{\link{xmlToDataFrame}},
  \code{\link{xmlParse}}
}
\examples{
f = system.file("exampleData", "solr.xml", package = "XML")
readSolrDoc(f)
}
\keyword{IO}
\concept{Solr}