View source: R/template_core_metadata.R
template_core_metadata | R Documentation |
Core information to all data packages (abstract, methods, keywords, personnel, license). Describes what the data are, why and how they were created, who was involved in their creation, and under what license the data are released.
template_core_metadata(
path,
license,
file.type = ".txt",
write.file = TRUE,
x = NULL
)
path |
(character) Path to the metadata template directory. |
license |
(character) License to publicly release the data package under. Use "CC0" or "CCBY". |
file.type |
(character; optional) File type for abstract, methods, and additional info. Can be: ".txt" (plain text), ".docx" (MS Word), or ".md" (markdown). The relative benefits: ".docx" supports basic formatting (super/sub scripts, italics, symbols, accented characters) but doesn't support bulleted lists and formatted equations. ".md" supports less formatting than ".docx" but is open source. ".txt" doesn't support any formatting but is a common file type. |
write.file |
(logical; optional) Whether to write the template files. |
x |
(named list; optional) Alternative input to
|
abstract |
Describes the salient features of a dataset in a concise summary much like an abstract does in a journal article. It should cover what the data are and why they were created. |
methods |
Describes the data creation methods. Includes enough detail for future users to correctly use the data. Lists instrument descriptions, protocols, etc. |
keywords |
Describes the data in a small set of terms. Keywords facilitate search and discovery on scientific terms, as well as names of research groups, field stations, and other organizations. Using a controlled vocabulary or thesaurus vastly improves discovery. We recommend using the LTER Controlled Vocabulary when possible. Columns:
|
personnel |
Describes the personnel and funding sources involved in the creation of the data. This facilitates attribution and reporting. Columns:
|
intellectual_rights |
Describes how the data may be used. Releasing without restriction (CC0) or with minimal attribution (CC BY) maximizes value and future use. |
additional_info |
Ancillary info not captured by any of the other templates. |
## Not run:
# Set working directory
setwd("/Users/me/Documents/data_packages/pkg_260")
# For data licensed under CC0 and using .docx files for the abstract and methods
template_core_metadata(
path = "./metadata_templates",
license = "CC0",
file.type = ".docx")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.