Repository files navigation

Thedata.world package is the main R package for working with datasetsondata.world.
Using this packages users can:

• Query and join datasets
• Choose between SQL and SPARQL
• Publish insights
• Use data.world's REST API (via includeddwapi package)

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

library(data.world)vignette("quickstart",package="data.world")

Here is a simple example:

intro_ds<-"https://data.world/jonloyens/an-intro-to-dataworld-dataset"sample_query<-data.world::qry_sql(paste0("SELECT t.Name, t.Height, s.AssistsPerGame","FROM DataDotWorldBBallTeam as t","JOIN DataDotWorldBBallStats as s ON t.Name = s.Name","ORDER BY s.AssistsPerGame DESC"))data.world::query(sample_query,dataset=intro_ds)

Notice thatdataset 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"

For your convenience, this package allows you to publishinsightstodata projectswithout leaving R Studio.

Using R Studio's "Addins" menu, look forDATA.WORLD > New insight.

The add-in will automatically capture the active plot in R Studio's plotview and give you the opportunity to quickly choose the project, and entertitle and description for your insight.

To install directly from GitHub:

devtools::install_github("datadotworld/data.world-r",build_vignettes=TRUE,ref="main")

Note: You will need to have the devtools package for R installed to run the previous command. If that is not already installed, you can install it from CRAN using the command:

install.packages("devtools")

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 thatis intended to be shared with others.

Configuration can be provided in 3 forms:

• Via config file
• Via environment variables
• At runtime

Config files are the most convenient configuration method. Once savedconfiguration will be automatically restored whendata.world is loaded.

From the R console:

saved_cfg<-data.world::save_config("YOUR API TOKEN")data.world::set_config(saved_cfg)

For additional configuration options, see?set_config

Check out thequickstart andquery vignette and the package documentation (?data.world).

> vignette("quickstart", package = "data.world")> ?data.world

We've removed the package from CRAN and recommend installing directly from Github.