Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve DESCRIPTION #47

Merged
merged 14 commits into from
Jul 10, 2015
Merged

Improve DESCRIPTION #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
23db73c
upgrade packages to newer versions and remove `pck1::`
dmpe Jul 7, 2015
6b13eeb
upgrade description for the seocnd time
dmpe Jul 7, 2015
2916b7a
import all, not just specific functions
dmpe Jul 7, 2015
ce84fd7
I have no idea what is being merge in what, and where is what being (…
dmpe Jul 8, 2015
b377cc7
delete curl dependency, unnecessary
dmpe Jul 8, 2015
0fe2457
smaller changes
dmpe Jul 8, 2015
04bb245
add @dmpe as an contributor
dmpe Jul 8, 2015
cc1ba9f
@param a xxx -> should be @param a - xxx
dmpe Jul 8, 2015
f4f7beb
update travis and add back ::s
dmpe Jul 10, 2015
bb8123c
update travis, and add 2 exported methods
dmpe Jul 10, 2015
2da69f1
do include man dir
dmpe Jul 10, 2015
4ebbaf6
no need for curl lib
dmpe Jul 10, 2015
8c5a9be
update readme (#48); split news/chagelog to its own file (better user…
dmpe Jul 10, 2015
5403fdb
update contributing.md to reflect the change to testthat
dmpe Jul 10, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .Rbuildignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ RSocrata.Rcheck
^.*\.Rproj$
^\.Rproj\.user$
.DS_Store
README.md
^\.travis\.yml$
appveyor.yml
CONTRIBUTING.md
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
/.README.md.html
/.settings
/DESCRIPTION.Rcheck
/man
/out
/RCheck
/RSocrata_*.tar.gz
Expand Down
32 changes: 13 additions & 19 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +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:
- global:
- WARNINGS_ARE_ERRORS=1
r_github_packages:
- hadley/httr
- jeroenooms/jsonlite
- jeroenooms/curl
- klutometis/roxygen
- jimhester/covr
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is some clever stuff, even if it's no longer necessary


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:
- Rscript -e "install.packages('roxygen2', repos='http://cran.us.r-project.org'); library(roxygen2); roxygen2::roxygenize(package.dir='.', roclets=c('rd', 'collate', 'namespace'))"
- ./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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ When you want to make a change, either to fix a bug or introduce a new feature,
* 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 `R/tests/testRSocrata.R`
* 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)
29 changes: 17 additions & 12 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Package: RSocrata
Type: Package
Title: Download 'Socrata' Data Sets as R Data Frames
Description: Provides easier interaction with
Socrata open data portals http://dev.socrata.com.
Expand All @@ -8,18 +9,22 @@ Description: Provides easier interaction with
returns an R data frame.
Converts dates to 'POSIX' format.
Manages throttling by 'Socrata'.
Version: 1.6.1-2
Date: 2015-6-5
URL: https://github.com/Chicago/RSocrata
BugReports: https://github.com/Chicago/RSocrata/issues
Imports:
httr (>= 0.3),
jsonlite (>= 0.9.14),
mime (>= 0.2),
Version: 1.6.2
Date: 2015-7-15
Authors@R: c(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll actually change this back to the old Author before pushing to CRAN. The CRAN guys are really picky that my email address in Authors@R match that of the Maintainer's email address. However, I like to separate the emails for general contact information from contacting me for package maintenance (CRAN will send e-mail blasts and I also use the email address in other projects I maintain). I prefer the Authors@R, but was getting cross with the CRAN submission process so used the old style.

person("Hugh", "Devlin, Ph. D.", role = c("aut")),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we keep the URL and BugReports?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a specious remove. The lines are "added" (i.e., kept) on lines 29 and 30 in the new file.

person("Tom", "Schenk Jr.", role = c("aut", "cre"), email = "developers@cityofchicago.org"),
person("John", "Malc", email = "cincenko@outlook.com", role = c("ctb"), comment = "@dmpe")
)
Depends:
curl (>= 0.5)
R (>= 3.0.0)
Imports:
httr (>= 1.0.0),
jsonlite (>= 0.9.16),
mime (>= 0.3)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to check

Suggests:
RUnit
Author: Hugh Devlin, Ph. D. and Tom Schenk, Jr.
Maintainer: Tom Schenk Jr <developers@cityofchicago.org>
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
View file
Open in desktop
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)
importFrom("httr", "parse_url", "build_url", "http_status", "stop_for_status", "GET", "content")
importFrom("mime", "guess_type")
importFrom("jsonlite", "fromJSON")
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
View file
Open in desktop
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