R 入门指南
开工
- 先执行
tutorial-authoring,完整读取其质量标准,再读取 content-structure.md。 - 明确读者已经会什么、读完要完成什么任务,以及可用于练习的最小数据或文件。
- 新建文章前核对
00xx编号、相近主题、稳定 URL 和_quarto.yml位置。 - 涉及 R、RStudio、Positron、Quarto 或包接口时核对当前官方文档;不要复用过期界面和安装步骤。
- 按 共同辨析合同 判断当前任务是否涉及初学者容易混淆的相邻概念,例如对象类型、赋值与比较、向量化与循环、脚本与控制台。只有误解会影响当前任务时才比较,不提前堆进阶术语。
教学主线
按学习问题组织内容,不固定章节数、行数或文字/代码比例。入门教程通常依次完成:建立任务语境、解释最少必要概念、给出可复制的最小示例、展示预期输出、让读者完成一个小练习,并说明失败时从哪里检查。
- 一个例子只引入少量新概念;后续例子复用前文对象,避免每节重新造数据。
- 代码块前说明输入和目的,代码块后解释输出中需要看的量;不逐行翻译显而易见的语法。
- 类比只用于建立直觉,随后明确其不能覆盖的技术边界。
- 易混淆概念在第一次代码使用前用最小反例、短表或对象结构说明;不要等到常见错误章节才纠正读者已经形成的误解。
- 错误示例必须能实际复现,并给出错误信息、最早检查点、原因和修复。
- 学习路线以能力和可验证任务分阶段,不承诺固定周数,也不把安装大量包当作学习成果。
需要编写路线图时读取 learning-roadmap.md。
代码与环境
- 从空白 R 会话按文章顺序实跑全部可执行代码;随机过程才设置种子。
- 优先使用小而真实的数据结构,不通过隐藏 warning、错误或输出制造“顺利”体验。
- 安装与日常代码分开。缺少运行时、系统库或外部软件时遵循仓库依赖规则,不默认改全局环境。
- 展示文件路径时说明工作目录并使用本项目可复现的相对路径。
图件
读取 visual-templates.md。真实控制台、编辑器、文档和图形均来自实际运行或渲染。只有关系、顺序或层级用文字难以追踪时才生成内容图;封面和示意图均不设数量指标。
验证与导航
- 运行项目教程审计脚本并实跑示例。
- 定向渲染目标文章,检查代码、表格、图件、中文和移动端可读性。
- 更新
doc/_quarto.yml后从doc/运行Rscript generate_sections.R。 - 只渲染
sections/guide.qmd、index.qmd与目标文章,扫描完整日志中的 warning/error。