ckanr

R client for the CKAN API

https://github.com/ropensci/ckanr

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.2%) to scientific vocabulary

Keywords

api-wrapper ckan ckan-api open-data r r-package rstats

Last synced: 4 months ago · JSON representation

Repository

R client for the CKAN API

Basic Info

Host: GitHub
Owner: ropensci
License: other
Language: R
Default Branch: main
Homepage: https://docs.ropensci.org/ckanr
Size: 888 KB

Statistics

Stars: 99
Watchers: 13
Forks: 38
Open Issues: 32
Releases: 6

Topics

api-wrapper ckan ckan-api open-data r r-package rstats

Created about 11 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing License Codemeta

README.Rmd

ckanr
=====

```{r echo=FALSE}
knitr::opts_chunk$set(
  comment = "#>",
  collapse = TRUE,
  warning = FALSE,
  message = FALSE
)
```

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-check](https://github.com/ropensci/ckanr/workflows/R-check/badge.svg)](https://github.com/ropensci/ckanr/actions/)
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/ckanr?color=FAB657)](https://github.com/r-hub/cranlogs.app)
[![cran version](https://www.r-pkg.org/badges/version/ckanr)](https://cran.r-project.org/package=ckanr)
[![Coverage](https://img.shields.io/codecov/c/github/ropensci/ckanr/main)](https://app.codecov.io/gh/ropensci/ckanr)


`ckanr` is an R client for the CKAN API.

## Description

CKAN is an open source set of tools for hosting and providing data on the web. (CKAN users could include non-profits, museums, local city/county governments, etc.).

`ckanr` allows users to interact with those CKAN websites to create, modify, and manage datasets, as well as search and download pre-existing data, and then to proceed using in R for data analysis (stats/plotting/etc.). It is meant to be as general as possible, allowing you to work with any CKAN instance.

Get started: 

## Installation

Stable CRAN version

```{r eval=FALSE}
install.packages("ckanr")
```

Development version

```{r eval=FALSE}
install.packages("remotes")
remotes::install_github("ropensci/ckanr")
```

```{r}
library('ckanr')
```

Note: the default base CKAN URL is set to 
Functions requiring write permissions in CKAN additionally require a privileged
CKAN API key.
You can change this using `ckanr_setup()`, or change the URL using the `url`
parameter in each function call.
To set one or both, run:

```{r}
ckanr_setup() # restores default CKAN url to https://data.ontario.ca/
ckanr_setup(url = "https://data.ontario.ca/")
ckanr_setup(url = "https://data.ontario.ca/", key = "my-ckan-api-key")
```

## ckanr package API

There are a suite of CKAN things (package, resource, etc.) that each have a set of functions in this package. The functions for each CKAN thing have an S3 class that is returned from most functions, and can be passed to most other functions (this also facilitates piping). The following is a list of the function groups for certain CKAN things, with the prefix for the functions that work with that thing, and the name of the S3 class:

+ Packages (aka packages) - `package_*()` - `ckan_package`
+ Resources - `resource_*()` - `ckan_resource`
+ Related - `related_*()` - `ckan_related`
+ Users - `user_*()` - `ckan_user`
+ Groups - `group_*()` - `ckan_group`
+ Tags - `tag_*()` - `ckan_tag`
+ Organizations  - `organization_*()` - `ckan_organization`
+ Groups - `group_*()` - `ckan_group`
+ Users - `user_*()` - `ckan_user`
+ Related items - `related_*()` - `ckan_related`

The S3 class objects all look very similar; for example:

```r
 8abc92ad-7379-4fb8-bba0-549f38a26ddb
  Name: Data From Digital Portal
  Description:
  Creator/Modified: 2015-08-18T19:20:59.732601 / 2015-08-18T19:20:59.657943
  Size:
  Format: CSV
```

All classes state the type of object, have the ID to the right of the type, then have a varying set of key-value fields deemed important. This printed object is just a summary of an R list, so you can index to specific values (e.g., `result$description`). If you feel there are important fields left out of these printed summaries, let us know.

> note: Many examples are given in brief for readme brevity


## Contributors

(alphabetical)

* Florian Mayer
* Francisco Alves
* Imanuel Costigan
* Scott Chamberlain
* Sharla Gelfand
* Wush Wu

## Meta

* Please [report any issues or bugs](https://github.com/ropensci/ckanr/issues).
* License: MIT
* Get citation information for `ckanr` in R doing `citation(package = 'ckanr')`
* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

Owner

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "ckanr",
  "description": "Client for 'CKAN' API (<https://ckan.org/>). Includes interface to 'CKAN' 'APIs' for search, list, show for packages, organizations, and resources. In addition, provides an interface to the 'datastore' API.",
  "name": "ckanr: Client for the Comprehensive Knowledge Archive Network ('CKAN') API",
  "relatedLink": "https://docs.ropensci.org/ckanr/",
  "codeRepository": "https://github.com/ropensci/ckanr",
  "issueTracker": "https://github.com/ropensci/ckanr/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.7.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.2.2 (2022-10-31)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Chamberlain",
      "email": "myrmecocystus@gmail.com",
      "@id": "https://orcid.org/0000-0003-1444-9135"
    },
    {
      "@type": "Person",
      "givenName": "Imanuel",
      "familyName": "Costigan",
      "email": "i.costigan@me.com"
    },
    {
      "@type": "Person",
      "givenName": "Wush",
      "familyName": "Wu",
      "@id": "https://orcid.org/0000-0001-5180-0567"
    },
    {
      "@type": "Person",
      "givenName": "Florian",
      "familyName": "Mayer",
      "email": "Florian.Mayer@dbca.wa.gov.au",
      "@id": "https://orcid.org/0000-0003-4269-4242"
    },
    {
      "@type": "Person",
      "givenName": "Sharla",
      "familyName": "Gelfand"
    },
    {
      "@type": "Person",
      "givenName": "Francisco",
      "familyName": "Alves",
      "email": "fjunior.alves.oliveira@gmail.com",
      "@id": "https://orcid.org/0000-0003-3390-0534"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Francisco",
      "familyName": "Alves",
      "email": "fjunior.alves.oliveira@gmail.com",
      "@id": "https://orcid.org/0000-0003-3390-0534"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "readxl",
      "name": "readxl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=readxl"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "xml2",
      "name": "xml2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=xml2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "lazyeval",
      "name": "lazyeval",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=lazyeval"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "DBI",
      "name": "DBI",
      "version": ">= 0.3.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=DBI"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "stats",
      "name": "stats"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "crul",
      "name": "crul",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=crul"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "version": ">= 0.9.17",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jsonlite"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "version": ">= 0.7.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dplyr"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "dbplyr",
      "name": "dbplyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dbplyr"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "magrittr",
      "name": "magrittr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=magrittr"
    },
    "SystemRequirements": null
  },
  "applicationCategory": "DataAccess",
  "isPartOf": "\"https://ropensci.org\"",
  "keywords": [
    "database",
    "open-data",
    "ckan",
    "api",
    "data",
    "dataset",
    "ckan-api",
    "api-wrapper",
    "r",
    "rstats",
    "r-package"
  ],
  "fileSize": "331.599KB",
  "releaseNotes": "https://github.com/ropensci/ckanr/blob/main/NEWS.md",
  "readme": "https://github.com/ropensci/ckanr/blob/main/README.md",
  "contIntegration": [
    "https://github.com/ropensci/ckanr/actions/",
    "https://app.codecov.io/gh/ropensci/ckanr"
  ],
  "developmentStatus": "https://www.repostatus.org/#active"
}

GitHub Events

Total

Issues event: 3
Watch event: 3
Delete event: 1
Issue comment event: 12
Push event: 5
Pull request event: 1
Create event: 2

Last Year

Issues event: 3
Watch event: 3
Delete event: 1
Issue comment event: 12
Push event: 5
Pull request event: 1
Create event: 2

Packages

Total packages: 1
Total downloads: unknown

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 6

proxy.golang.org: github.com/ropensci/ckanr

Documentation: https://pkg.go.dev/github.com/ropensci/ckanr#section-documentation
License: other
Latest release: v0.7.0
published almost 3 years ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.5%

Average: 5.7%

Dependent repos count: 5.9%

Last synced: 5 months ago

Dependencies

DESCRIPTION cran

DBI >= 0.3.1 depends
crul * imports
dbplyr * imports
dplyr >= 0.7.0 imports
jsonlite >= 0.9.17 imports
magrittr * imports
methods * imports
stats * imports
utils * imports
lazyeval * suggests
readxl * suggests
sf * suggests
testthat * suggests
xml2 * suggests

.github/workflows/R-check.yaml actions

actions/checkout v3 composite
actions/upload-artifact v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

docker-compose.yml docker

ckan/ckan-postgres-dev 2.8
ckan/ckan-solr 2.8
ghcr.io/keitaroinc/datapusher 0.0.17
openknowledge/ckan-base 2.8
redis 5.0.14

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science