Skip to contents

Within data_classify_files()'s coarse "documentation" type, distinguish the specific artifact: the (collection-level) readme, a codebook, or plain supplemental text (preprints, slide decks, Word docs). This is the axis psychds_check uses to decide root-vs-per-study placement and that codebook_check uses to select which files to parse – orthogonal to data_type, which only says "this is documentation of some kind."

Usage

.data_doc_role(file_name)

Arguments

file_name

a character vector of file names (basenames)

Value

a character vector: "readme", "license", "codebook", "supplemental", or NA for files that are not data_type == "documentation".

Details

ro-crate-metadata.json is treated as a "readme" role: like a README, it is collection-level (root, singular), never assigned to a single study.