patentsview

[crew102]

Summary

• What does this package do? (explain in 50 words or less):

This package provides a wrapper around the patentsview api, which serves USPTO patent data that has been disambiguated. There is one main function to search and download data from the API (search_pv) and several other helper functions.

• Paste the full DESCRIPTION file inside a code block below:

Package: patentsview
Type: Package
Title: An R Client to the PatentsView API
Version: 0.1.0.9000
Authors@R: person("Christopher", "Baker", email = "chriscrewbaker@gmail.com",
    role = c("aut", "cre"))
Encoding: UTF-8
Description: Provides functions to simplify the PatentsView API
    (http://www.patentsview.org/api/doc.html) query language,
    send GET and POST requests to the API's seven endpoints, and parse the data
    that comes back.
URL: https://github.com/crew102/patentsview
BugReports: https://github.com/crew102/patentsview/issues
License: GPL-2
LazyData: TRUE
Depends:
    R (>= 3.1)
Imports:
    httr,
    jsonlite,
    utils
Suggests:
    knitr,
    rmarkdown,
    testthat
VignetteBuilder: knitr
RoxygenNote: 6.0.1

• URL for the package (the development repository, not a stylized html page): master branch on github

• Who is the target audience?
  Researchers who want to interact with patent data. There are several specific use cases of patent data that have been listed in this thread of the rOpenSci discussion board.

• Are there other R packages that accomplish the same thing? If so, what is different about yours? I know of two R packages that one can use to download patent data: lensr and a development version of opsr. lensr is the most similar, as it can be used to download USPTO patent data. I do not know of any other packages that wrap patentsview, which is the only service that provides USPTO data that has been disambiguated.

Requirements

Confirm each of the following by checking the box. This package:

• [X] does not violate the Terms of Service of any service it interacts with.
• [X] has a CRAN and OSI accepted license.
• [X] contains a README with instructions for installing the development version.
• [X] includes documentation with examples for all functions.
• [x] contains a vignette with examples of its essential functions and uses.
• [X] has a test suite.
• [X] has continuous integration with Travis CI and/or another service.

Publication options

• [X] Do you intend for this package to go on CRAN?
• [ ] Do you wish to automatically submit to the Journal of Open Source Software? If so:
• [ ] The package contains a paper.md with a high-level description in the package root or in inst/.
• [ ] The package is deposited in a long-term repository with the DOI:
• (Do not submit your package separately to JOSS)

Detail

• [X] Does R CMD check (or devtools::check()) succeed? Paste and describe any errors or warnings:

R CMD check passes with one warning regarding this being my first package submission.

• [X] Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:

I believe the package follows the guidelines, but there are a few items I would like to highlight. These may or may not be issues:

1. The README does not follow the exact same format as described in the packaging guidelines.
2. I have added a cran-comment.md file which I plan on updating before submitting to CRAN.
3. I have not tagged the git repo yet, as I would like to wait for feedback before considering this version complete.

• If this is a resubmission following rejection, please explain the change in circumstances:

• If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names:

[crew102]

No problem - I thought the process was well done. I'm changing the urls now and will open a pr to integrate those into ropensci/patentsview. I'm also changing the badge urls for travis and appveyor.

[maelle]

Cool!

The repo was activated on Travis and I think on Appveyor for which the badges will be [![Build status](https://ci.appveyor.com/api/projects/status/ri4lrakyrw2117mi?svg=true)](https://ci.appveyor.com/project/ropensci/patentsview)

No need for a PR, you can commit and push directly well unless you prefer doing it with a branch.

[maelle]

We can discuss further in the thread but I'll close this now.

Thanks @crew102 for your work, and @expectopatronum & @poldham for your reviews!

[crew102]

Sounds good..I did a PR but I'll probably just push directly to ropensci/patentsview master in the future. Thanks again for your help.

[maelle]

I'd like to tweet about the package, are you on Twitter?

[crew102]

I'm not on twitter but a tweet would be nice!

[maelle]

https://twitter.com/ma_salmon/status/876822469843267584 :white_check_mark:

[crew102]

Hi @maelle , is it ok if I submit patentsview to CRAN without the ropensci footer in the readme? I'm getting this warning when I build on winbuilder (which I assume will be a showstopper for CRAN admins):

checking top-level files ... WARNING
Conversion of 'README.md' failed:
pandoc.exe: Could not fetch http://ropensci.org/public_images/github_footer.png
TlsExceptionHostPort (HandshakeFailed Error_EOF) "ropensci.org" 80

[maelle]

@crew102 yes with that Pandoc bug the best is to remove it before CRAN submission and then put it back afterwards. Hopefully that bug will be resolved soon.

Would you be interested in writing a blog post about patentsview for rOpenSci blog?

[crew102]

Sure, I could do a post. I'd like to submit to CRAN first. I'll let you know when that process is over. Are there any guidelines/suggestions for writing the blog posts?

[maelle]

Awesome! I'll let @stefaniebutland take over reg. the blog post (she's rOpenSci community manager), she'll be able to tell you more regarding timing & content of the blog post.

In any case I look forward to reading it!

Good luck with the CRAN submission, don't hesitate to ask any question if needed.

[crew102]

Thanks a lot!