Skip to content

Commit

Permalink
Merge pull request #51 from Chicago/dev
Browse files Browse the repository at this point in the history
Pull request for v1.6.1
  • Loading branch information
Tom Schenk Jr committed Jul 11, 2015
2 parents b37d679 + 6e118d4 commit cdda8f7
Show file tree
Hide file tree
Showing 20 changed files with 598 additions and 321 deletions.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ RSocrata.Rcheck
^.*\.Rproj$
^\.Rproj\.user$
.DS_Store
README.md
^\.travis\.yml$
appveyor.yml
CONTRIBUTING.md
14 changes: 6 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
/.settings
/.git
/.project
/.Rbuildignore.Rcheck
/.README.md.html
/man
/.git
/RSocrata_*.tar.gz
/RCheck
/.settings
/DESCRIPTION.Rcheck
/out
/RCheck
/RSocrata_*.tar.gz
/RSocrata.Rcheck
*.pdf
/DESCRIPTION.Rcheck
/.Rbuildignore.Rcheck
*.Rproj.user
*.Rproj
*.Rproj.user
*.Rhistory
Expand Down
30 changes: 13 additions & 17 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,23 @@
#
# See README.md for instructions, or for more configuration options,
# see the wiki:
# https://github.com/craigcitro/r-travis/wiki
# http://docs.travis-ci.com/user/languages/r/

language: c
language: R
sudo: required
warnings_are_errors: true

env:
- R_MY_PKG="$(basename $TRAVIS_REPO_SLUG)"
r_github_packages:
- hadley/httr
- jeroenooms/jsonlite
- jeroenooms/curl
- klutometis/roxygen
- jimhester/covr

before_install:
- curl -OL http://raw.github.com/craigcitro/r-travis/master/scripts/travis-tool.sh
- chmod 755 ./travis-tool.sh
- ./travis-tool.sh bootstrap
install:
- ./travis-tool.sh install_deps
script:
- ./travis-tool.sh run_tests
- Rscript -e 'source("R/tests/testRSocrata.R"); runAllTestsCI()'

after_failure:
- ./travis-tool.sh dump_logs
after_success:
- Rscript -e 'library(covr);coveralls()'

notifications:
email:
on_success: change
on_failure: change
on_failure: change
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

# How to contribute

We really appreciate when users [fix bugs](https://github.com/Chicago/RSocrata/pull/25) or [provide new features](https://github.com/Chicago/RSocrata/pull/21). When submitting changes, please read below to help the development team keep on top of issues and changes.

## Submitting a bug

If you notice something strange, please [submit an issue on GitHub](https://github.com/Chicago/RSocrata/issues). In the issue, please try to achieve the following:

* Describe what you did
* Describe what happened when you did it
* Describe what you think should happen
* If possible, describe where you think the error is occuring

If you have multiple issues, please submit multiple requests. Once you submit your report, we'll often engage in a conversation or give it a label to be fixed.

## Making Changes

When you want to make a change, either to fix a bug or introduce a new feature, please follow the instructions below

* Create a branch or fork of the project based off of the `dev` branch.
* Make commits of logical units
* Add unit tests for any new features
* Run all tests in `tests/testthat/`
* Create a pull request with a robust description or [reference the issue number](https://github.com/Chicago/RSocrata/issues)
28 changes: 15 additions & 13 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
Package: RSocrata
Type: Package
Title: Download 'Socrata' Data Sets as R Data Frames
Description: Provides easier interaction with
Socrata open data portals \url{http://dev.socrata.com}.
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'.
Version: 1.6.0-12
Date: 2015-4-20
URL: https://github.com/Chicago/RSocrata
BugReports: https://github.com/Chicago/RSocrata/issues
Version: 1.6.2-9
Date: 2015-7-10
Author: Hugh Devlin, Ph. D., Tom Schenk, Jr., and John Malc
Maintainer: "Tom Schenk Jr." <developers@cityofchicago.org>
Depends:
httr (>= 0.3),
jsonlite (>= 0.9.14),
mime (>= 0.2)
R (>= 3.0.0)
Imports:
curl (>= 0.5)
httr (>= 1.0.0),
jsonlite (>= 0.9.16),
mime (>= 0.3)
Suggests:
RUnit
Author: Hugh Devlin, Ph. D. and Tom Schenk, Jr.
Maintainer: "Tom Schenk Jr." <developers@cityofchicago.org>
License: MIT + file LICENSE
testthat (>= 0.10.0),
roxygen2 (>= 4.1.0)
License: MIT + file LICENSE
URL: https://github.com/Chicago/RSocrata
BugReports: https://github.com/Chicago/RSocrata/issues
18 changes: 13 additions & 5 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# Generated by roxygen2 (4.1.1): do not edit by hand

export(fieldName)
export(isFourByFour)
export(ls.socrata)
export(posixify)
export(read.socrata)
export(ls.socrata)
import(jsonlite)
import(httr)
import(mime)
import(curl)
export(validateUrl)
importFrom(httr,GET)
importFrom(httr,build_url)
importFrom(httr,content)
importFrom(httr,http_status)
importFrom(httr,parse_url)
importFrom(httr,stop_for_status)
importFrom(jsonlite,fromJSON)
importFrom(mime,guess_type)
45 changes: 45 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
### 1.1
Add check for valid Socrata resource URL. Add check for supported download file format. Add support for Socrata short dates.

### 1.2
Use comma-separated file format for Socrata downloads.

### 1.3
* Added support for human-readable URL. Users can now copy and paste URLs of Socrata-hosted datasets, which will be transformed into a valid SoDA API web query.

* Added additional RUnit tests to validate new functionality.

### 1.4
Add json file format for Socrata downloads. Switch to `RJSONIO` from `rjson`.

### 1.5 Several changes:

* Swapped to ```jsonlite``` from ```RJSONIO```
* Added handling for long and short dates
* Added unit test for reading private datasets

### 1.5.1
Deprecated ```httr::guess_media()``` and implemented ```mime::guess_type()```

### 1.6.0 Several changes:

* New function, ```ls.socrata``` to list all datasets on a Socrata portal.
* New optional argument, ```app_token```, which lets users supply an API token while using ```read.socrata()``` to minimize throttling.
* Repairs a bug where ```read.socrata``` failed when reading in a date with a column, but there are null values in that column.
* Minor changes to the DESCRIPTION documentation to point users to GitHub for issues and provides new contact information.

### 1.6.1 Bug fixes:

* Resolved potential [name collision issue](https://github.com/Chicago/RSocrata/issues/42)
* Cleaned-up documentation with contributor instructions [#23](https://github.com/Chicago/RSocrata/issues/23) and [#28](https://github.com/Chicago/RSocrata/issues/28))
* Moved test coverage in `RUnit` to `testthat` and implemented code coverage monitoring ([#41](https://github.com/Chicago/RSocrata/issues/41))
* Clean-up DESCRIPTION ([#40](https://github.com/Chicago/RSocrata/issues/40))
* Add continuous integration for Windows ([#39](https://github.com/Chicago/RSocrata/issues/39))
* Migrate Travis-CI to "proper" R YAML ([#46](https://github.com/Chicago/RSocrata/issues/46))







Loading

0 comments on commit cdda8f7

Please sign in to comment.