R/PostalAddress.R

In cboettig/schemar: Create Structured Data Using the Schema.org Vocabulary

#' PostalAddress 
#'
#' The mailing address. 
#'
#'
#' @param id identifier for the object (URI)
#' @param telephone (Text or Text or Text or Text type.) The telephone number.
#' @param serviceArea (Place or GeoShape or AdministrativeArea or Place or GeoShape or AdministrativeArea or Place or GeoShape or AdministrativeArea type.) The geographic area where the service is provided.
#' @param productSupported (Text or Product type.) The product or service this support contact point is related to (such as product support for a particular product line). This can be a specific product or product line (e.g. "iPhone") or a general category of products or services (e.g. "smartphones").
#' @param hoursAvailable (OpeningHoursSpecification or OpeningHoursSpecification or OpeningHoursSpecification type.) The hours during which this service or contact is available.
#' @param faxNumber (Text or Text or Text or Text type.) The fax number.
#' @param email (Text or Text or Text type.) Email address.
#' @param contactType (Text type.) A person or organization can have different contact points, for different purposes. For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point.
#' @param contactOption (ContactPointOption type.) An option available on this contact point (e.g. a toll-free number or support for hearing-impaired callers).
#' @param availableLanguage (Text or Language or Text or Language or Text or Language or Text or Language type.) A language someone may use with or at the item, service or place. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]]
#' @param areaServed (Text or Place or GeoShape or AdministrativeArea or Text or Place or GeoShape or AdministrativeArea or Text or Place or GeoShape or AdministrativeArea or Text or Place or GeoShape or AdministrativeArea or Text or Place or GeoShape or AdministrativeArea or Text or Place or GeoShape or AdministrativeArea type.) The geographic area where a service or offered item is provided.
#' @param streetAddress (Text type.) The street address. For example, 1600 Amphitheatre Pkwy.
#' @param postalCode (Text or Text or Text type.) The postal code. For example, 94043.
#' @param postOfficeBoxNumber (Text type.) The post office box number for PO box addresses.
#' @param addressRegion (Text type.) The region. For example, CA.
#' @param addressLocality (Text type.) The locality. For example, Mountain View.
#' @param addressCountry (Text or Country or Text or Country or Text or Country type.) The country. For example, USA. You can also provide the two-letter [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1).
#' @param url (URL type.) URL of the item.
#' @param sameAs (URL type.) URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
#' @param potentialAction (Action type.) Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
#' @param name (Text type.) The name of the item.
#' @param mainEntityOfPage (URL or CreativeWork type.) Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
#' @param image (URL or ImageObject type.) An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
#' @param identifier (URL or Text or PropertyValue type.) The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
#' @param disambiguatingDescription (Text type.) A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
#' @param description (Text type.) A description of the item.
#' @param alternateName (Text type.) An alias for the item.
#' @param additionalType (URL type.) An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
#'
#' @return a list object corresponding to a schema:PostalAddress
#'
#' @export

 PostalAddress <- function(id = NULL,
telephone = NULL,
 serviceArea = NULL,
 productSupported = NULL,
 hoursAvailable = NULL,
 faxNumber = NULL,
 email = NULL,
 contactType = NULL,
 contactOption = NULL,
 availableLanguage = NULL,
 areaServed = NULL,
 streetAddress = NULL,
 postalCode = NULL,
 postOfficeBoxNumber = NULL,
 addressRegion = NULL,
 addressLocality = NULL,
 addressCountry = NULL,
 url = NULL,
 sameAs = NULL,
 potentialAction = NULL,
 name = NULL,
 mainEntityOfPage = NULL,
 image = NULL,
 identifier = NULL,
 disambiguatingDescription = NULL,
 description = NULL,
 alternateName = NULL,
 additionalType = NULL){ 
Filter(Negate(is.null),
 list(
type = "PostalAddress",
id = id,
telephone = telephone,
serviceArea = serviceArea,
productSupported = productSupported,
hoursAvailable = hoursAvailable,
faxNumber = faxNumber,
email = email,
contactType = contactType,
contactOption = contactOption,
availableLanguage = availableLanguage,
areaServed = areaServed,
streetAddress = streetAddress,
postalCode = postalCode,
postOfficeBoxNumber = postOfficeBoxNumber,
addressRegion = addressRegion,
addressLocality = addressLocality,
addressCountry = addressCountry,
url = url,
sameAs = sameAs,
potentialAction = potentialAction,
name = name,
mainEntityOfPage = mainEntityOfPage,
image = image,
identifier = identifier,
disambiguatingDescription = disambiguatingDescription,
description = description,
alternateName = alternateName,
additionalType = additionalType))}