https://github.com/datadotworld/dwapi-r
R client package for data.world API
https://github.com/datadotworld/dwapi-r
api-client datasets dwstruct-t50-public-projects open-data reference-implementation
Last synced: about 2 months ago
JSON representation
R client package for data.world API
- Host: GitHub
- URL: https://github.com/datadotworld/dwapi-r
- Owner: datadotworld
- License: apache-2.0
- Created: 2017-04-24T21:17:44.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T08:32:02.000Z (over 1 year ago)
- Last Synced: 2025-05-08T21:14:44.416Z (about 2 months ago)
- Topics: api-client, datasets, dwstruct-t50-public-projects, open-data, reference-implementation
- Language: R
- Homepage: https://data.world/integrations/r
- Size: 197 KB
- Stars: 7
- Watchers: 36
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
# dwapi
[](https://circleci.com/gh/datadotworld/dwapi-r)
The `dwapi` R package makes it easy to use [data.world's REST API](https://docs.data.world/documentation/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.
```R
library(dwapi)
vignette("quickstart", package = "dwapi")
```
Here is a simple example:
```R
intro_dataset <- dwapi::get_dataset(
owner_id = "jonloyens",
dataset_id = "an-intro-to-dataworld-dataset")
```
## Installation
To get the current version from GitHub:
```R
devtools::install_github("datadotworld/dwapi-r", build_vignettes = TRUE, ref = "main")
```
## 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`:
```R
> library(dwapi)
> dwapi::configure(auth_token = "YOUR_TOKEN_GOES_HERE")
```
# Next
Check out the `quickstart` vignette and the package documentation (`?dwapi`).
```R
> vignette("quickstart", package = "dwapi")
> ?dwapi
```