This repository has been archived by the owner on Sep 9, 2022. It is now read-only.
Releases: ropensci-archive/rplos
Releases · ropensci-archive/rplos
rplos 0.5.2
rplos v0.5.0
rplos 0.4.7
NEW FEATURES
- New function
citations()
for querying the PLOS Rich Citations API (#88)
BUG FIXES
- Added
vignettes/figure
to.Rbuildignore
as requested by CRAN admin (#87)
v0.4.6
NEW FEATURES
- API key no longer required (#86)
MINOR IMPROVEMENTS
searchplos()
now returns a list of length two,meta
anddata
, andmeta
is a data.frame of metadata for the search.- Switched from CC0 to MIT license.
- No longer importing libraries
RCurl
,data.table
,googleVis
,assertthat
,RJSONIO
, andstringr
(#79) (#82) (#84) - Now importing
dplyr
. - Moved
jsonlite
from Suggests to Imports. Replaces use ofRJSONIO
. (#80) crossref()
now defunct. See packagercrossref
https://github.com/ropensci/rcrossref. (#83)highplos()
now usessolr::solr_highlight()
to do highlight searches.searchplos()
,plosabstract()
, and other functions that wrapsearchplos()
now use...
to pass in curl options tohttr::GET()
. You'll now get an error on usingcallopts
parameter.- Added manual file entry for the dataset
isocodes
. - Reworked both
plosword()
andplot_throughtime()
to have far less code, useshttr
now instead ofRCurl
, but to the user, everything should be the same. - Made documentation more clear on discrepancy between PLOS website behavior and
rplos
behavior, and how to make them match, or match more closely (#76) - Added package level man file to allow
?rplos
to go to help page.
BUG FIXES
v0.4.0
NEW FEATURES
- Errors from the data provider are reported now. At least we attempt to do so when they are given, for example if you specify
asc
ordesc
incorrectly with thesort
parameter. See thecheck_response()
function for examples. - New functions
facetplos()
andhighplos()
using thesolr
R wrapper to the Solr indexing engine. The PLOS API just exposes the Solr endpoints, so we can use the general Solr wrapper packagesolr
to allow more flexible Solr searching. - New function
highbrow()
to visualize highlighting results in a browser. - New function
plos_fulltext()
to get full text xml of PLOS articles. Helper functionfull_text_urls()
constructs the URL's for full text xml.
BUG FIXES
- Fixed bug in tests where we forgot to give a key. No key is required per se, but PLOS encourages it so we prevent a call from happening without at least a dumby key.
- Added function
check_response()
to check responses from the PLOS API, deals with capturing server error messages, and checking for correct content type, etc.
IMPROVEMENTS
- Removed function
crossref_r()
as we are working on a package for the CrossRef API. - Parameter arguments in
searchplos()
,plosauthor()
,plosfigtabcaps()
,plossubject()
, andplostitle()
were changed to match closer the Solr parameter names.terms
toq
.fields
tofl
.toquery
tofq
. - Multiple values passed to
fields
returndf
parameter is gone fromsearchplos()
,plosauthor()
,plosfigtabcaps()
,plossubject()
, andplostitle()
. You can easily get raw JSON, etc. data using thesolr
package.- Now using
httr
instead ofRCurl
inplosviews()
function.
v0.3.6
rplos 0.3.6
NEW FEATURES
- All search functions (searchplos(), plosabstract(), plosauthor(), plosfigtabcaps(), plossubject(), and plostitle()) gain highlighting argument, setting to TRUE (default=FALSE) returns matching sentence fragments that were matched. NOTE that if highlighting=TRUE the output can be a list of data.frame's if returndf=TRUE, with two named elements 'data' and 'highlighting', or a list of lists if returndf=FALSE.
- All search functions (searchplos(), plosabstract(), plosauthor(), plosfigtabcaps(), plossubject(), and plostitle()) gain sort argument. You can pass a field to sort by even if you don't return that field in the output, e.g., sort='counter_total_month desc'.
- A tiny function parsehighlight() added to parse out html code from highlighting output.
BUG FIXES
- Some examples in docs didn't work - fixed them.
- Fixed bug in searchplos() that was causing elements of a return field to cause failure because they were longer than 1 (e.g., authors). Now concatenating elements of length > 1.
- Fixed bug in searchplos() that was causing elements of length 0 to cause failure. Now removing elements of length 0.
- Fixed parsehighlight function to return NA if highlighting return of length 0.
- Fixed broken test for plosauthor(), plosabstract(), and plot_throughtime().