A Client for 'data.world' REST API

A set of wrapper functions for 'data.world' REST API endpoints < https://apidocs.data.world>.


CircleCI cran version

The dwapi R package makes it easy to use data.world's REST API in R.
Using the package, users can:

  • Create and update datasets, metadata and files
  • Query datasets using SQL and SPARQL
  • Download files and entire datasets

Getting Started

To get started, load the library and checkout the quickstart vignette.

library(dwapi)
vignette("quickstart", package = "dwapi")

Here is a simple example:

intro_dataset <- dwapi::get_dataset(
  dataset = "https://data.world/jonloyens/an-intro-to-dataworld-dataset")

Notice that dataset is parameter required by most functions and can be provided in two formats:

  1. URL: "https://data.world/jonloyens/an-intro-to-dataworld-dataset"
  2. Path: "jonloyens/an-intro-to-dataworld-dataset"

Installation

To get the current released version from CRAN:

install.packages("dwapi")

To get the current development version from GitHub:

devtools::install_github("datadotworld/dwapi-r", build_vignettes = TRUE)

Configuration

First, users must obtain an API authentication token at: https://data.world/settings/advanced

IMPORTANT: For your security, do not include your API authentication token in code that is intended to be shared with others.

To configure the package, use dwapi::configure:

> dwapi::configure(auth_token = "YOUR_TOKEN_GOES_HERE")

Next

Check out the quickstart vignette and the package documentation (?dwapi).

> vignette("quickstart", package = "dwapi")
> ?dwapi

News

0.1.3

  • Wrapper functions for Streams API:

    • append_data_frame_to_stream
    • append_record_to_stream
    • append_values_to_stream
  • Wrapper functions for Projects API:

    • create_project
    • replace_project
    • update_project
    • get_project
    • delete_project
    • link_dataset
    • unlink_dataset
  • Wrapper functions for Insights API:

    • get_insight
    • get_insights
    • delete_insight
    • replace_insight
    • update_insight
  • Wrapper functions for Datasets API:

    • delete_dataset
  • Misc improvements and bug fixes

0.1.2

  • Address compatibility issues with testthat 2.0.0
  • Additional wrapper functions for API endpoints
    • get_user
    • get_datasets_user_own, get_datasets_user_liked, get_datasets_user_contributing
    • get_projects_user_own, get_projects_user_liked, get_projects_user_contributing
    • create_insight

0.1.1

  • Fix tests making them compliant with CRAN policies
  • Improve quickstart vignette
  • Improve accuracy of documentation and examples

0.1.0

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("dwapi")

0.1.3.1 by ORPHANED, a year ago


https://github.com/datadotworld/dwapi-r


Report a bug at https://github.com/datadotworld/dwapi-r/issues


Browse source code at https://github.com/cran/dwapi


Authors: Rafael Pereira [aut, cre] , Triet Le [aut] , Bryon Jacob [aut] , Scott Came [aut]


Documentation:   PDF Manual  


Apache License 2.0 license


Imports httr, readr, rjson, xml2, jsonlite

Suggests knitr, rmarkdown, testthat, mockery, curl


Depended on by data.world.


See at CRAN