CroissantIssues: problems found in Croissant metadata

Returned by validate_croissant(). An error makes the metadata invalid; a warning names a recommended property that is absent or a construct that is read in a way the author may not intend.

Usage

CroissantIssues(
  issues = data.frame(severity = character(), check = character(), node = character(),
    message = character())
)

Arguments

issues

data.frame: One row per issue, with character columns severity ("error" or "warning"), check (the check that found it), node (the @id of the node, or the node type when it has none), and message.

Value

CroissantIssues object.

Author

EDG

Examples

x <- validate_croissant(Croissant(name = "minimal"))
x

#> <CroissantIssues>
#>   0 errors, 4 warnings
#>   Warnings
#>   - [Croissant(minimal)] The recommended property citeAs is absent.
#>   - [Croissant(minimal)] The recommended property datePublished is absent.
#>   - [Croissant(minimal)] The recommended property license is absent.
#>   - [Croissant(minimal)] The recommended property version is absent.

x@issues

#>   severity                check               node
#> 1  warning recommended_property Croissant(minimal)
#> 2  warning recommended_property Croissant(minimal)
#> 3  warning recommended_property Croissant(minimal)
#> 4  warning recommended_property Croissant(minimal)
#>                                             message
#> 1        The recommended property citeAs is absent.
#> 2 The recommended property datePublished is absent.
#> 3       The recommended property license is absent.
#> 4       The recommended property version is absent.