generate_llm_prompt: Create a copy-paste prompt for LLMs

In FakeDataR: Privacy-Preserving Synthetic Data for 'LLM' Workflows

Create a copy-paste prompt for LLMs

Description

Create a copy-paste prompt for LLMs

Usage

generate_llm_prompt(
  fake_path,
  schema_path = NULL,
  notes = NULL,
  write_file = TRUE,
  path = dirname(fake_path),
  filename = "README_FOR_LLM.txt"
)

Arguments

fake_path	Path to the fake data file (CSV/RDS/Parquet).
schema_path	Optional path to the JSON schema.
notes	Optional extra notes to append for the analyst/LLM.
write_file	Write a README txt next to the files? Default TRUE.
path	Output directory for the README if write_file = TRUE.
filename	README file name. Default "README_FOR_LLM.txt".

Value

The prompt string (invisibly returns the file path if written).

FakeDataR documentation built on Nov. 6, 2025, 1:15 a.m.