https://github.com/sckott/canadiana

Canadiana R client
https://github.com/sckott/canadiana

Last synced: over 1 year ago
JSON representation

Canadiana R client

• Host: GitHub
• URL: https://github.com/sckott/canadiana
• Owner: sckott
• License: other
• Created: 2015-01-26T06:37:09.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-04-24T14:15:35.000Z (about 9 years ago)
• Last Synced: 2025-03-23T23:36:10.740Z (over 1 year ago)
• Language: R
• Homepage:
• Size: 20.5 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

          
canadiana

=======

```{r echo=FALSE}

knitr::opts_chunk$set(

  warning = FALSE,

  message = FALSE,

  collapse = TRUE,

  comment = "#>"

)

```

[![Build Status](https://travis-ci.org/sckott/canadiana.svg)](https://travis-ci.org/sckott/canadiana)

[![codecov.io](https://codecov.io/github/sckott/canadiana/coverage.svg?branch=master)](https://codecov.io/github/sckott/canadiana?branch=master)

`canadiana` is an R client for the Canadiana API

* [Canadiana](http://search.canadiana.ca/) - _Search the digital collections of libraries, archives and museums from across Canada_

* API docs: [http://search.canadiana.ca/support/api](http://search.canadiana.ca/support/api)

## Install

```{r eval=FALSE}

install.packages("devtools")

devtools::install_github("sckott/canadiana")

```

```{r}

library("canadiana")

```

## Search for records

```{r}

out <- cearch(q="railroads")

out$meta

```

```{r}

out$facet

```

```{r}

head(out$docs)

```

By language

```{r}

cearch(lang="spa")$meta

```

By record type

```{r}

cearch(type="page")$meta

```

Date delimit

```{r}

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

```

Sorting

```{r}

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

```

Paging

```{r eval=FALSE}

# FIX ME - paging doesn' work for some reason

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

```

## Get single item

```{r}

item("oocihm.00001")

```