create_data_origin: Create Data Origin Documentation

In qtkit: Quantitative Text Kit

Create Data Origin Documentation

Description

Creates a standardized data origin documentation file in CSV format, containing essential metadata about a dataset's source, format, and usage rights.

Usage

create_data_origin(file_path, return = FALSE, force = FALSE)

Arguments

file_path	Character string. Path where the CSV file should be saved.
return	Logical. If TRUE, returns the data frame in addition to saving. Default is FALSE.
force	Logical. If TRUE, overwrites existing file at path. Default is FALSE.

Details

Generates a template with the following metadata fields:

• Resource name

• Data source (URL/DOI)

• Sampling frame (language, modality, genre)

• Collection dates

• Data format

• Schema description

• License information

• Attribution requirements

Value

If return=TRUE, returns a data frame containing the data origin template. Otherwise returns invisible(NULL).

Examples

tmp_file <- tempfile(fileext = ".csv")
create_data_origin(tmp_file)
read.csv(tmp_file)

qtkit documentation built on April 4, 2025, 4:47 a.m.