cearch: Search Canadiana

Description Usage Arguments Examples

Description

FIX ME - paging doesn' work for some reason

Usage

1
2
3
cearch(q = NULL, au = NULL, ti = NULL, su = NULL, contributor = NULL,
  media = NULL, lang = NULL, set = NULL, type = NULL, key = NULL,
  pkey = NULL, df = NULL, dt = NULL, sort = NULL, page = NULL, ...)

Arguments

q

(character) Query terms, full text field

au

(character) Author/creator names, full text field

ti

(character) Titles, full text field

su

(character) Subject headings/keywords, full text field

contributor

(character) Contributor code

media

(character) Media type, one of text, image, audio, video, data, or plaintext

lang

(character) Document language, a 3 letter code from ISO 693-3, http://www-01.sil.org/iso639-3/codes.asp

set

(character) Index subset

type

(character) Type of record, one of any, document, series, page, or default (document and series)

key

(character) Record unique key

pkey

(character) Record parent key

df

(character) Date from

dt

(character) Date to

sort

(character) Sort direction, one of oldest or newest

page

(integer) Page number

...

Curl options passed on to GET

Examples

 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
## Not run: 
out <- cearch(q="railroads")
out$meta
out$facet
head(out$docs)

# various search egs
cearch("rail*")$meta
cearch("rail yards")$meta
cearch('"rail yards" -railway')$meta
cearch('rail yard | car')$meta
cearch('su:railroads')$meta
cearch(su="railroads")$meta
cearch(su="railroads", q="su:Newfoundland")$meta

# By language
cearch(lang="spa")$meta

# By record type
cearch(type="page")$meta

# dates
cearch(q="railroads", df=1800, dt=1820)$meta

# sorting
cearch(q="railroads", df=1800, dt=1820, sort="oldest")$docs

# paging
cearch(q="railroads", page=2)$meta

## End(Not run)

sckott/canadiana documentation built on May 29, 2019, 3:47 p.m.