url_with_page: URL With Page function to modify a url to set count & start...

Description Usage Arguments Value Examples

View source: R/search_api_funs.r

Description

URL With Page function to modify a url to set count & start parameters - useful when mapping over pages of query

Usage

1

Arguments

url

url to modify - as prepared by build_gov_query

count

(single integer) Maximum number of search results to return. If insufficient documents match, as many as possible are returned (subject to the supplied start offset). This may be set to 0 to return no results (which may be useful if only, say, facet values are wanted). Setting this to 0 will reduce processing time.

start

(single integer) Position in search result list to start returning results (0-based) If the start offset is greater than the number of matching results, no results will be returned (but also no error will be returned).

Value

url with count and start modified

Examples

1
2
# get second 10 pages
url_with_page(build_gov_query(), count = 10, start = 10)

mattmalcher/gov.uk.taxonomy documentation built on Jan. 25, 2020, 12:45 a.m.