{"id":14037104,"url":"https://github.com/Chicago/RSocrata","last_synced_at":"2025-07-27T04:34:17.335Z","repository":{"id":10649582,"uuid":"12878765","full_name":"Chicago/RSocrata","owner":"Chicago","description":"Provides easier interaction with Socrata open data portals http://dev.socrata.com. Users can provide a 'Socrata' data set resource URL, or a 'Socrata' Open Data API (SoDA) web query, or a 'Socrata' \"human-friendly\" URL, returns an R data frame. Converts dates to 'POSIX' format. Manages throttling by 'Socrata'.","archived":false,"fork":false,"pushed_at":"2023-09-01T21:11:13.000Z","size":562,"stargazers_count":232,"open_issues_count":41,"forks_count":84,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-04-27T23:34:18.976Z","etag":null,"topics":["chicago","government","open-data","r","socrata","soda"],"latest_commit_sha":null,"homepage":"https://CRAN.R-project.org/package=RSocrata","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chicago.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2013-09-16T21:03:40.000Z","updated_at":"2024-03-12T12:37:48.000Z","dependencies_parsed_at":"2023-01-13T16:04:28.482Z","dependency_job_id":"479841ca-fa9f-478c-a2db-2c1839876ccf","html_url":"https://github.com/Chicago/RSocrata","commit_stats":{"total_commits":291,"total_committers":16,"mean_commits":18.1875,"dds":0.6426116838487972,"last_synced_commit":"b7ae8c52c0c9800776b8dad6fd02d4c92254ee77"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chicago%2FRSocrata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chicago%2FRSocrata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chicago%2FRSocrata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chicago%2FRSocrata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chicago","download_url":"https://codeload.github.com/Chicago/RSocrata/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227762476,"owners_count":17816032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chicago","government","open-data","r","socrata","soda"],"created_at":"2024-08-12T03:02:28.981Z","updated_at":"2024-12-02T16:31:55.892Z","avatar_url":"https://github.com/Chicago.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"RSocrata\n========\n\n[![Gitter](https://badges.gitter.im/repo.svg)](https://app.gitter.im/#/room/#Chicago_RSocrata:gitter.im)\n[![downloads](https://cranlogs.r-pkg.org/badges/RSocrata)](https://CRAN.R-project.org/package=RSocrata)\n[![cran version](https://www.r-pkg.org/badges/version/RSocrata)](https://CRAN.R-project.org/package=RSocrata)\n\n**Master** \n\nStable beta branch. Test about-to-be-released features in a stable pre-release build before it is submitted to CRAN.\n\n[![Linux build - Master](https://img.shields.io/travis/Chicago/RSocrata/master.svg?style=flat-square\u0026label=Linux%20build)](https://app.travis-ci.com/Chicago/RSocrata)[![Windows build - Master](https://img.shields.io/appveyor/ci/tomschenkjr/RSocrata/master.svg?style=flat-square\u0026label=Windows%20build)](https://ci.appveyor.com/project/tomschenkjr/rsocrata/branch/master)[![Coverage - Master](https://img.shields.io/coveralls/Chicago/RSocrata/master.svg?style=flat-square\u0026label=Coverage)](https://coveralls.io/github/Chicago/RSocrata?branch=master)\n\n**Dev**\n\n\"Nightly\" alpha branch. Test the latest features and bug fixes -- enjoy at your own risk.\n\n[![Linux build - Dev](https://img.shields.io/travis/Chicago/RSocrata/dev.svg?style=flat-square\u0026label=Linux%20build)](https://app.travis-ci.com/Chicago/RSocrata)[![Windows build - Dev](https://img.shields.io/appveyor/ci/tomschenkjr/RSocrata/dev.svg?style=flat-square\u0026label=Windows%20build)](https://ci.appveyor.com/project/tomschenkjr/rsocrata/branch/dev)[![Coverage - Dev](https://img.shields.io/coveralls/Chicago/RSocrata/dev.svg?style=flat-square\u0026label=Coverage)](https://coveralls.io/github/Chicago/RSocrata?branch=dev)\n\nA tool for downloading and uploading Socrata datasets\n-----------------------------------------------------\n\nProvided with a URL to a dataset resource published on a [Socrata](https://www.tylertech.com/products/data-insights) webserver,\nor a Socrata [SoDA (Socrata Open Data Application Program Interface) web API](https://dev.socrata.com) query,\nor a Socrata \"human-friendly\" URL, ```read.socrata()```\nreturns an [R data frame](https://stat.ethz.ch/R-manual/R-devel/library/base/html/data.frame.html).\nConverts dates to [POSIX](https://stat.ethz.ch/R-manual/R-devel/library/base/html/DateTimeClasses.html) format.\nSupports CSV and JSON download file formats from Socrata.\nManages the throttling of data returned from Socrata and allows users to provide an [application token](https://dev.socrata.com/docs/app-tokens.html).\nSupports [SoDA query parameters](https://dev.socrata.com/docs/queries.html) in the URL string for further filtering, sorting, and queries.\nUpload data to Socrata data portals using \"upsert\" and \"replace\" methods.\n\nUse ```ls.socrata()``` to list all datasets available on a Socrata webserver.\n\n[testthat](https://cran.r-project.org/package=testthat) test coverage.\n\n## Installation\n\n\nTo get the current released version from CRAN:\n\n```R\ninstall.packages(\"RSocrata\")\n```\n\nThe most recent beta with soon-to-be-released changes can be installed from GitHub:\n\n```R\n# install.packages(\"devtools\")\ndevtools::install_github(\"Chicago/RSocrata\")\n```\n\nThe \"nightly\" version with the most recent bug fixes and features is also available. This version is always an alpha and may contain significant bugs. You can install it from the `dev` branch from GitHub:\n\n```R\n# install.packages(\"devtools\")\ndevtools::install_github(\"Chicago/RSocrata\", ref=\"dev\")\n```\n\nExamples\n--------\n\n### Reading SoDA valid URLs\n```r\nearthquakesDataFrame \u003c- read.socrata(\"https://soda.demo.socrata.com/resource/4334-bgaj.csv\")\nnrow(earthquakesDataFrame) # 1007 (two \"pages\")\nclass(earthquakesDataFrame$Datetime[1]) # POSIXlt\n```\n\n### Reading \"human-readable\" URLs\n```r\nearthquakesDataFrame \u003c- read.socrata(\"https://soda.demo.socrata.com/dataset/USGS-Earthquakes-for-2012-11-01-API-School-Demo/4334-bgaj\")\nnrow(earthquakesDataFrame) # 1007 (two \"pages\")\nclass(earthquakesDataFrame$Datetime[1]) # POSIXlt\n```\n\n### Using API key to read datasets\n```r\ntoken \u003c- \"ew2rEMuESuzWPqMkyPfOSGJgE\"\nearthquakesDataFrame \u003c- read.socrata(\"https://soda.demo.socrata.com/resource/4334-bgaj.csv\", app_token = token)\nnrow(earthquakesDataFrame)\n```\n\n### Download private datasets from portal\n```r\n# Store user email and password\nsocrataEmail \u003c- Sys.getenv(\"SOCRATA_EMAIL\", \"mark.silverberg+soda.demo@socrata.com\")\nsocrataPassword \u003c- Sys.getenv(\"SOCRATA_PASSWORD\", \"7vFDsGFDUG\")\n\nprivateResourceToReadCsvUrl \u003c- \"https://soda.demo.socrata.com/resource/a9g2-feh2.csv\" # dataset\n\nread.socrata(url = privateResourceToReadCsvUrl, email = socrataEmail, password = socrataPassword)\n```\n\n### List all datasets on portal\n```r\nallSitesDataFrame \u003c- ls.socrata(\"https://soda.demo.socrata.com\")\nnrow(allSitesDataFrame) # Number of datasets\nallSitesDataFrame$title # Names of each dataset\n```\n\n### Upload data to portal\n```r\n# Store user email and password\nsocrataEmail \u003c- Sys.getenv(\"SOCRATA_EMAIL\", \"mark.silverberg+soda.demo@socrata.com\")\nsocrataPassword \u003c- Sys.getenv(\"SOCRATA_PASSWORD\", \"7vFDsGFDUG\")\n\ndatasetToAddToUrl \u003c- \"https://soda.demo.socrata.com/resource/xh6g-yugi.json\" # dataset\n \n# Generate some data\nx \u003c- sample(-1000:1000, 1)\ny \u003c- sample(-1000:1000, 1)\ndf_in \u003c- data.frame(x,y)\n \n# Upload to Socrata\nwrite.socrata(df_in,datasetToAddToUrl,\"UPSERT\",socrataEmail,socrataPassword)\n```\n\n## Issues\n\nPlease report issues, request enhancements or fork us at the [City of Chicago github](https://github.com/Chicago/RSocrata/issues).\n\n## Contributing\n\nIf you would like to contribute to this project, please see the [contributing documentation](https://github.com/Chicago/RSocrata/blob/master/CONTRIBUTING.md) and the [product roadmap](https://github.com/Chicago/RSocrata/wiki/Roadmap#planned-releases).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChicago%2FRSocrata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FChicago%2FRSocrata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChicago%2FRSocrata/lists"}