JosiahParry / opensecrets

An OpenSecrets API wrapper for R
7 stars 0 forks source link

add imports: to DESCRIPTON; add /rmd files (files to 'test' functions) #6

Closed jimrothstein closed 4 years ago

jimrothstein commented 4 years ago

Hi Josiah: Didn't see you last note till today.

First attempt at pull request.

Could you look things over BEFORE attempting merge.
For example, I added a /rmd folders and files. You may not want this. I use the rmd files to test FUNCTIONS, typical USE CASES and the like. Might be basis for future vignettes. But primary purpose (for me) is just to be sure pkg does what I think it should it do; convenience.

Second, if this PR goes OK, I have another batch of changes (stop_for_status()) waiting to do PR.

Third, before we get too far. Possible to chat a bit by phone? For example, what do you see as DEMAND for an update opensecrets R package? Audience? USE cases? Timetable? In other words, can you sketch where this might go and its iportance to your organization and your plans?? Thx.

JosiahParry commented 4 years ago

Hi Jim,

This pull request (PR) should only change the DESCRIPTION file. The rmd directory is for your personal use and as such shouldn't be included in an R package. I'd recommend reading http://r-pkgs.had.co.nz/ for an idea of what belongs inside of an R package. One thing you can do in the future is include these sort of files to your .gitignore file.

I am going to close this PR without merging. I'd ask for your to create a clean fork and changing only the description file. After that is done, please create the pull request. So long as only the DESCRIPTION file is changed I am happy to give it a merge.


Regarding your other questions: I do not have many plans for this package as of now. Though I suspect with some thorough love it can become a rather useful tool for political science research. I have not publicized the fact that this package exists. One hope would be to put this package in a good place and then request Opensecrets to reference this package rather than the outdated one that is linked to today.