Skip to contents

Coerce lists and character vectors to origin

Source: R/info-origin.R
as_origin.Rd

as_origin() turns an existing object into an origin. This is in contrast with class_origin(), which builds an origin from individual properties.

Usage

as_origin(x, ..., arg = caller_arg(x), call = caller_env())

Arguments

x

The object to coerce. Must be empty or have names "url", "format", and/or "version", or names that can be coerced to those names via snakecase::to_snake_case(). Extra names are ignored. This object should describe a single origin for this API description.

...

These dots are for future extensions and must be empty.

arg

An argument name as a string. This argument will be mentioned in error messages as the input that is at the origin of a problem.

call

The execution environment of a currently running function, e.g. caller_env(). The function will be mentioned in error messages as the source of the error. See the call argument of abort() for more information.

Value

An origin as returned by class_origin().

See also

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

Examples

as_origin()
#> <rapid::origin>
#>  @ url    : chr(0) 
#>  @ format : chr(0) 
#>  @ version: chr(0) 
as_origin(
  list(
    list(
      format = "openapi",
      url = "https://api.open.fec.gov/swagger/",
      version = "3.0"
    )
  )
)
#> <rapid::origin>
#>  @ url    : chr "https://api.open.fec.gov/swagger/"
#>  @ format : chr "openapi"
#>  @ version: chr "3.0"