Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

Commit

Permalink
#65 add to docs for bison_solr that you can use start for offset in p…
Browse files Browse the repository at this point in the history
…agination
  • Loading branch information
sckott committed Jul 18, 2019
1 parent 27aaf52 commit 3bdbe72
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Description: Interface to the 'USGS' 'BISON' (<https://bison.usgs.gov/>)
species in the United States from participating data providers. You can get
data via 'taxonomic' and location based queries. A simple function
is provided to help visualize data.
Version: 0.8.0.9100
Version: 0.8.0.9130
License: MIT + file LICENSE
URL: https://github.com/ropensci/rbison
BugReports: https://github.com/ropensci/rbison/issues
Expand Down
7 changes: 7 additions & 0 deletions R/bison_solr.r
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,12 @@
#'
#' - fl: Fields to return in the query
#' - rows: Number of records to return
#' - start: Record number to start at (an offset)
#' - sort: Field to sort by, see examples
#' - facet: Facet or not, logical
#' - facet.field: Fields to facet by
#'
#' To do pagination, use `rows` and `start` together
#'
#' You can also use highlighting in solr search, but I'm not sure I see a
#' use case for it with BISON data, though you can do it with this function.
Expand Down Expand Up @@ -133,6 +136,10 @@
#'
#' bison_solr(providerID = 220)
#'
#' # pagination
#' bison_solr(scientificName = 'Ursus americanus', rows = 10)
#' bison_solr(scientificName = 'Ursus americanus', rows = 10, start = 10)
#'
#' # combining parameters
#' x <- bison_solr(eventDate = c('2008-01-01', '2010-12-31'),
#' ITISscientificName="Helianthus annuus", rows = 100)
Expand Down
7 changes: 7 additions & 0 deletions man/bison_solr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3bdbe72

Please sign in to comment.