cff | R Documentation |
cff
objects from direct inputsA class and utility methods for reading, creating and holding CFF
information. See cff_class to learn more about cff
objects.
cff(path, ...)
cff()
would convert _
in the name of the argument to -
, e.g.
cff_version = "1.2.0'
would be converted to cff-version = "1.2.0'
.
Valid parameters are those specified on cff_schema_keys()
:
cff-version
message
type
license
title
version
doi
identifiers
abstract
authors
preferred-citation
repository
repository-artifact
repository-code
commit
url
date-released
contact
keywords
references
license-url
A cff
object. Under the hood, a cff
object is a regular list
object with a special print
method.
Other core functions of cffr:
cff_create()
,
cff_modify()
,
cff_validate()
# Blank cff
cff()
# Use custom params
test <- cff(
title = "Manipulating files",
keywords = c("A", "new", "list", "of", "keywords"),
authors = as_cff_person("New author")
)
test
# Would fail
cff_validate(test)
# Modify with cff_create
new <- cff_create(test, keys = list(
"cff_version" = "1.2.0",
message = "A blank file"
))
new
# Would pass
cff_validate(new)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.