Skip to contents

License information for the API

Source: R/info-license.R
class_license.Rd

A license object provides license information for the API to describe how the API can be used.

Usage

class_license(
  name = character(),
  ...,
  identifier = character(),
  url = character()
)

Arguments

name

Character scalar (optional). The license name used for the API.

...

These dots are for future extensions and must be empty.

identifier

Character scalar (optional). An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.

url

Character scalar (optional). A URL to the license used for the API. This must be in the form of a URL. The url field is mutually exclusive of the identifier field.

Value

A license S7 object describing allowed usage of the API, with fields name, identifier, and url.

See also

info object as_contact(), as_info(), as_license(), as_origin(), class_contact(), class_info(), class_origin()

Examples

class_license(
  "Apache 2.0",
  identifier = "Apache-2.0"
)
#> <rapid::license>
#>  @ name      : chr "Apache 2.0"
#>  @ identifier: chr "Apache-2.0"
#>  @ url       : chr(0) 
class_license(
  "Apache 2.0",
  url = "https://opensource.org/license/apache-2-0/"
)
#> <rapid::license>
#>  @ name      : chr "Apache 2.0"
#>  @ identifier: chr(0) 
#>  @ url       : chr "https://opensource.org/license/apache-2-0/"