docs/PersonalApi.md
In wing328/namsor-r-client: R Package Client for NamSor API v2
PersonalApi
All URIs are relative to https://v2.namsor.com/NamSorAPIv2
Method | HTTP request | Description
------------- | ------------- | -------------
Country | GET /api2/json/country/{personalNameFull} | [USES 10 UNITS] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
CountryBatch | POST /api2/json/countryBatch | [USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
Diaspora | GET /api2/json/diaspora/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
DiasporaBatch | POST /api2/json/diasporaBatch | [USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Gender | GET /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name.
GenderBatch | POST /api2/json/genderBatch | Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
GenderFull | GET /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith
GenderFullBatch | POST /api2/json/genderFullBatch | Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
GenderFullGeo | GET /api2/json/genderFullGeo/{fullName}/{countryIso2} | Infer the likely gender of a full name, given a local context (ISO2 country code).
GenderFullGeoBatch | POST /api2/json/genderFullGeoBatch | Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
GenderGeo | GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} | Infer the likely gender of a name, given a local context (ISO2 country code).
GenderGeoBatch | POST /api2/json/genderGeoBatch | Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
Origin | GET /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
OriginBatch | POST /api2/json/originBatch | [USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
ParsedGenderBatch | POST /api2/json/parsedGenderBatch | Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
ParsedGenderGeoBatch | POST /api2/json/parsedGenderGeoBatch | Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
UsRaceEthnicity | GET /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy.
UsRaceEthnicityBatch | POST /api2/json/usRaceEthnicityBatch | [USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
UsRaceEthnicityZIP5 | GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info.
UsZipRaceEthnicityBatch | POST /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Country
PersonalNameGeoOut Country(personal.name.full)
[USES 10 UNITS] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.personal.name.full <- 'personal.name.full_example' # character |
#[USES 10 UNITS] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Country(var.personal.name.full)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
personal.name.full | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
CountryBatch
BatchPersonalNameGeoOut CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
[USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new() # BatchPersonalNameIn | A list of personal names
#[USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Diaspora
FirstLastNameDiasporaedOut Diaspora(country.iso2, first.name, last.name)
[USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.country.iso2 <- 'country.iso2_example' # character |
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Diaspora(var.country.iso2, var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
country.iso2 | character| |
first.name | character| |
last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
DiasporaBatch
BatchFirstLastNameDiasporaedOut DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new() # BatchFirstLastNameGeoIn | A list of personal names
#[USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameDiasporaedOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Gender
FirstLastNameGenderedOut Gender(first.name, last.name)
Infer the likely gender of a name.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#Infer the likely gender of a name.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Gender(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderBatch
BatchFirstLastNameGenderedOut GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new() # BatchFirstLastNameIn | A list of personal names
#Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
GenderFull
FirstLastNameGenderedOut GenderFull(full.name)
Infer the likely gender of a full name, ex. John H. Smith
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
#Infer the likely gender of a full name, ex. John H. Smith
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFull(var.full.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
full.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderFullBatch
BatchPersonalNameGenderedOut GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new() # BatchPersonalNameIn | A list of personal names
#Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
GenderFullGeo
FirstLastNameGenderedOut GenderFullGeo(full.name, country.iso2)
Infer the likely gender of a full name, given a local context (ISO2 country code).
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a full name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeo(var.full.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
full.name | character| |
country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderFullGeoBatch
BatchPersonalNameGenderedOut GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
Example
library(namsor)
var.batch.personal.name.geo.in <- BatchPersonalNameGeoIn$new() # BatchPersonalNameGeoIn | A list of personal names, with a country ISO2 code
#Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.personal.name.geo.in | BatchPersonalNameGeoIn| A list of personal names, with a country ISO2 code | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
GenderGeo
FirstLastNameGenderedOut GenderGeo(first.name, last.name, country.iso2)
Infer the likely gender of a name, given a local context (ISO2 country code).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeo(var.first.name, var.last.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderGeoBatch
BatchFirstLastNameGenderedOut GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new() # BatchFirstLastNameGeoIn | A list of names, with country code.
#Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of names, with country code. | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Origin
FirstLastNameOriginedOut Origin(first.name, last.name)
[USES 10 UNITS] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Origin(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
OriginBatch
BatchFirstLastNameOriginedOut OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
[USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new() # BatchFirstLastNameIn | A list of personal names
#[USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
ParsedGenderBatch
BatchFirstLastNameGenderedOut ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.in <- BatchParsedFullNameIn$new() # BatchParsedFullNameIn | A list of personal names
#Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.parsed.full.name.in | BatchParsedFullNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
ParsedGenderGeoBatch
BatchFirstLastNameGenderedOut ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.geo.in <- BatchParsedFullNameGeoIn$new() # BatchParsedFullNameGeoIn | A list of personal names
#Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.parsed.full.name.geo.in | BatchParsedFullNameGeoIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
UsRaceEthnicity
FirstLastNameUSRaceEthnicityOut UsRaceEthnicity(first.name, last.name)
[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicity(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
UsRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new() # BatchFirstLastNameGeoIn | A list of personal names
#[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
UsRaceEthnicityZIP5
FirstLastNameUSRaceEthnicityOut UsRaceEthnicityZIP5(first.name, last.name, zip5.code)
[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.zip5.code <- 'zip5.code_example' # character |
#[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityZIP5(var.first.name, var.last.name, var.zip5.code)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
first.name | character| |
last.name | character| |
zip5.code | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
UsZipRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Example
library(namsor)
var.batch.first.last.name.geo.zipped.in <- BatchFirstLastNameGeoZippedIn$new() # BatchFirstLastNameGeoZippedIn | A list of personal names
#[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
batch.first.last.name.geo.zipped.in | BatchFirstLastNameGeoZippedIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
wing328/namsor-r-client documentation built on May 26, 2019, 7:01 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
PersonalApi
All URIs are relative to https://v2.namsor.com/NamSorAPIv2
Method | HTTP request | Description ------------- | ------------- | ------------- Country | GET /api2/json/country/{personalNameFull} | [USES 10 UNITS] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. CountryBatch | POST /api2/json/countryBatch | [USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. Diaspora | GET /api2/json/diaspora/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) DiasporaBatch | POST /api2/json/diasporaBatch | [USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) Gender | GET /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name. GenderBatch | POST /api2/json/genderBatch | Infer the likely gender of up to 1000 names, detecting automatically the cultural context. GenderFull | GET /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith GenderFullBatch | POST /api2/json/genderFullBatch | Infer the likely gender of up to 1000 full names, detecting automatically the cultural context. GenderFullGeo | GET /api2/json/genderFullGeo/{fullName}/{countryIso2} | Infer the likely gender of a full name, given a local context (ISO2 country code). GenderFullGeoBatch | POST /api2/json/genderFullGeoBatch | Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code). GenderGeo | GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} | Infer the likely gender of a name, given a local context (ISO2 country code). GenderGeoBatch | POST /api2/json/genderGeoBatch | Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code). Origin | GET /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. OriginBatch | POST /api2/json/originBatch | [USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context. ParsedGenderBatch | POST /api2/json/parsedGenderBatch | Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context. ParsedGenderGeoBatch | POST /api2/json/parsedGenderGeoBatch | Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context. UsRaceEthnicity | GET /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy. UsRaceEthnicityBatch | POST /api2/json/usRaceEthnicityBatch | [USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy. UsRaceEthnicityZIP5 | GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. UsZipRaceEthnicityBatch | POST /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Country
PersonalNameGeoOut Country(personal.name.full)
[USES 10 UNITS] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.personal.name.full <- 'personal.name.full_example' # character |
#[USES 10 UNITS] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Country(var.personal.name.full)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- personal.name.full | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
CountryBatch
BatchPersonalNameGeoOut CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
[USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new() # BatchPersonalNameIn | A list of personal names
#[USES 10 UNITS] Infer the likely country of residence of up to 1000 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$CountryBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Diaspora
FirstLastNameDiasporaedOut Diaspora(country.iso2, first.name, last.name)
[USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.country.iso2 <- 'country.iso2_example' # character |
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 20 UNITS] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Diaspora(var.country.iso2, var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- country.iso2 | character| | first.name | character| | last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
DiasporaBatch
BatchFirstLastNameDiasporaedOut DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new() # BatchFirstLastNameGeoIn | A list of personal names
#[USES 20 UNITS] Infer the likely ethnicity/diaspora of up to 1000 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$DiasporaBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameDiasporaedOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Gender
FirstLastNameGenderedOut Gender(first.name, last.name)
Infer the likely gender of a name.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#Infer the likely gender of a name.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Gender(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderBatch
BatchFirstLastNameGenderedOut GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new() # BatchFirstLastNameIn | A list of personal names
#Infer the likely gender of up to 1000 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
GenderFull
FirstLastNameGenderedOut GenderFull(full.name)
Infer the likely gender of a full name, ex. John H. Smith
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
#Infer the likely gender of a full name, ex. John H. Smith
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFull(var.full.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- full.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderFullBatch
BatchPersonalNameGenderedOut GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.personal.name.in <- BatchPersonalNameIn$new() # BatchPersonalNameIn | A list of personal names
#Infer the likely gender of up to 1000 full names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullBatch(batch.personal.name.in=var.batch.personal.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.in | BatchPersonalNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
GenderFullGeo
FirstLastNameGenderedOut GenderFullGeo(full.name, country.iso2)
Infer the likely gender of a full name, given a local context (ISO2 country code).
Example
library(namsor)
var.full.name <- 'full.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a full name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeo(var.full.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- full.name | character| | country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderFullGeoBatch
BatchPersonalNameGenderedOut GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
Example
library(namsor)
var.batch.personal.name.geo.in <- BatchPersonalNameGeoIn$new() # BatchPersonalNameGeoIn | A list of personal names, with a country ISO2 code
#Infer the likely gender of up to 1000 full names, with a given cultural context (country ISO2 code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderFullGeoBatch(batch.personal.name.geo.in=var.batch.personal.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.personal.name.geo.in | BatchPersonalNameGeoIn| A list of personal names, with a country ISO2 code | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
GenderGeo
FirstLastNameGenderedOut GenderGeo(first.name, last.name, country.iso2)
Infer the likely gender of a name, given a local context (ISO2 country code).
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.country.iso2 <- 'country.iso2_example' # character |
#Infer the likely gender of a name, given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeo(var.first.name, var.last.name, var.country.iso2)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| | country.iso2 | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
GenderGeoBatch
BatchFirstLastNameGenderedOut GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new() # BatchFirstLastNameGeoIn | A list of names, with country code.
#Infer the likely gender of up to 1000 names, each given a local context (ISO2 country code).
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$GenderGeoBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of names, with country code. | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Origin
FirstLastNameOriginedOut Origin(first.name, last.name)
[USES 10 UNITS] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$Origin(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
OriginBatch
BatchFirstLastNameOriginedOut OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
[USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.first.last.name.in <- BatchFirstLastNameIn$new() # BatchFirstLastNameIn | A list of personal names
#[USES 10 UNITS] Infer the likely country of origin of up to 1000 names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$OriginBatch(batch.first.last.name.in=var.batch.first.last.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.in | BatchFirstLastNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
ParsedGenderBatch
BatchFirstLastNameGenderedOut ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.in <- BatchParsedFullNameIn$new() # BatchParsedFullNameIn | A list of personal names
#Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderBatch(batch.parsed.full.name.in=var.batch.parsed.full.name.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.parsed.full.name.in | BatchParsedFullNameIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
ParsedGenderGeoBatch
BatchFirstLastNameGenderedOut ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
Example
library(namsor)
var.batch.parsed.full.name.geo.in <- BatchParsedFullNameGeoIn$new() # BatchParsedFullNameGeoIn | A list of personal names
#Infer the likely gender of up to 1000 fully parsed names, detecting automatically the cultural context.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$ParsedGenderGeoBatch(batch.parsed.full.name.geo.in=var.batch.parsed.full.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.parsed.full.name.geo.in | BatchParsedFullNameGeoIn| A list of personal names | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
UsRaceEthnicity
FirstLastNameUSRaceEthnicityOut UsRaceEthnicity(first.name, last.name)
[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
#[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicity(var.first.name, var.last.name)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
UsRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
Example
library(namsor)
var.batch.first.last.name.geo.in <- BatchFirstLastNameGeoIn$new() # BatchFirstLastNameGeoIn | A list of personal names
#[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityBatch(batch.first.last.name.geo.in=var.batch.first.last.name.geo.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.in | BatchFirstLastNameGeoIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
UsRaceEthnicityZIP5
FirstLastNameUSRaceEthnicityOut UsRaceEthnicityZIP5(first.name, last.name, zip5.code)
[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info.
Example
library(namsor)
var.first.name <- 'first.name_example' # character |
var.last.name <- 'last.name_example' # character |
var.zip5.code <- 'zip5.code_example' # character |
#[USES 10 UNITS] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsRaceEthnicityZIP5(var.first.name, var.last.name, var.zip5.code)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- first.name | character| | last.name | character| | zip5.code | character| |
Return type
FirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
UsZipRaceEthnicityBatch
BatchFirstLastNameUSRaceEthnicityOut UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
Example
library(namsor)
var.batch.first.last.name.geo.zipped.in <- BatchFirstLastNameGeoZippedIn$new() # BatchFirstLastNameGeoZippedIn | A list of personal names
#[USES 10 UNITS] Infer up-to 1000 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code.
api.instance <- PersonalApi$new()
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['X-API-KEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$UsZipRaceEthnicityBatch(batch.first.last.name.geo.zipped.in=var.batch.first.last.name.geo.zipped.in)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- batch.first.last.name.geo.zipped.in | BatchFirstLastNameGeoZippedIn| A list of personal names | [optional]
Return type
BatchFirstLastNameUSRaceEthnicityOut
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.