Package index • fairenough

All functions

LICENSE_CONFIG: License Configuration

build(): Build package components wrapper

build_citation(): Build CITATION file using cffr

build_license(): Build License

build_package(): Build package structure and core files

build_readme(): Build README from inst/templates/README.qmd

build_roxygen(): Generate roxygen documentation for datasets

build_site(): Build website with pkgdown

check_description_exists(): Validation system for fairenough pipeline steps

checklist_summary(): Get summary string for validation results

collect(): Collect metadata wrapper

collect_metadata(): Collect comprehensive metadata interactively

.collect_dataset_info(): Collect dataset information from .rda files

.create_directories(): Create project directories

.export_csv(): Export data as CSV file

.export_rda(): Export data as RDA file

.move_data_files(): Move data files to raw data directory

.run_checks(): Run package checks

.setup_gitignore(): Setup gitignore for data directory and R files

.validate_package(): Validate package with modern tools

ensure_directory(): Ensure directory exists with messaging

fairenough(): Main fairenough wrapper

filter_supported_files(): Filter files by supported extensions

format_checklist_results(): Process checklist into structured results

gendict(): Generate data dictionary using LLM

generate(): Generation of documentation for datasets

generate_dictionary(): Generate data dictionary

get_available_licenses(): Get Supported License Names

get_base_path(): Get base path with consistent handling across all functions

get_key(): Get key from DESCRIPTION file

get_license_config(): Get License Configuration

get_metadata(): Get metadata from DESCRIPTION file

get_raw_dir(): Get raw directory path with consistent handling across all functions

get_supported_extensions(): Get supported file extensions

is_supported_file_type(): Check if file type is supported

match_license(): Match License to License Config

process(): Process data wrapper

process_clean(): Clean data with standard transformations

process_data(): Process all data files

prompt_confirm(): Yes/No confirmation

prompt_input(): General-purpose prompting utilities for R

prompt_menu(): Menu selection using utils::menu()

prompt_multi_select(): Multiple selection menu

read_data(): Read data from various sources

save_metadata(): Save metadata to DESCRIPTION file

setup(): Setup wrapper

setup_package(): Setup fairenough project structure

show_checklist(): Display formatted checklist to user

use_template(): Use a template file with data substitution

validate_data_frame(): Validate data frame

validate_file_path(): Validate file path

validate_setup_completed(): Validate setup completion status

validate_email() validate_package_name() validate_orcid() validate_date() validate_url(): Common validators