api_parameter_reference

This dataset contains the mapping that allows this package to use a 
universal syntax to specify parameters for different geocoder services.
The <code>generic_name</code> field is a universal field name while the <code>api_name</code>
field shows the specific parameter name for the given geocoder service (<code>method</code>).
When the <code>api_name</code> is missing this means that the parameter is not 
supported by the given geocoder service. When <code>generic_name</code> is missing 
this means the parameter is specific to that geocoding service. 
Reference the documentation for <code><a rd-options="" href="/link/geo?package=tidygeocoder&version=1.0.1" data-mini-rdoc="tidygeocoder::geo">geo</a></code> for more information. 
Also reference <code>vignette("tidygeocoder")</code> for more details on constructing API queries.

datasets

An intuitive interface for getting data from geocoder services.

Jesse Cambon

tidygeocoder

Geocoding Made Easy

api_parameter_reference function

A tibble dataframe<dl class="dl-horizontal">
 <dt>method</dt><dd>Geocoder service name</dd>
 <dt>generic_name</dt><dd>Universal parameter name</dd>
 <dt>api_name</dt><dd>Name of the parameter for the specified geocoder service</dd>
 <dt>default_value</dt><dd>Default value of the parameter</dd>
 <dt>required</dt><dd>Is the parameter required by the specified geocoder service?</dd>
</dl>

Format

This dataset contains the mapping that allows this package to use a 
universal syntax to specify parameters for different geocoder services.
The <code>generic_name</code> field is a universal field name while the <code>api_name</code>
field shows the specific parameter name for the given geocoder service (<code>method</code>).
When the <code>api_name</code> is missing this means that the parameter is not 
supported by the given geocoder service. When <code>generic_name</code> is missing 
this means the parameter is specific to that geocoding service. 
Reference the documentation for <code><a rd-options='' href='geo'>geo</a></code> for more information. 
Also reference <code>vignette("tidygeocoder")</code> for more details on constructing API queries.

Geocoder service API parameter reference — api_parameter_reference

A tibble dataframe<dl class='dl-horizontal'>
 <dt>method</dt><dd>Geocoder service name</dd>
 <dt>generic_name</dt><dd>Universal parameter name</dd>
 <dt>api_name</dt><dd>Name of the parameter for the specified geocoder service</dd>
 <dt>default_value</dt><dd>Default value of the parameter</dd>
 <dt>required</dt><dd>Is the parameter required by the specified geocoder service?</dd>
</dl>

api_parameter_reference: Geocoder service API parameter reference

Description

Usage

Arguments

Format

See Also