Browse / Research & science / Manuscript-Workspace-Template
Manuscript-Workspace-Template
Super-Yael
空白的 R 数据分析 + LaTeX 论文工作区。按研究功能组织,用到什么再添加什么。
Open Super-Yael/Manuscript-Workspace-Template → Checked against the four rules.
Works with any agent
ships AGENTS.md, the cross-tool instruction file.
In its own words
空白的 R 数据分析 + LaTeX 论文工作区。按研究功能组织,用到什么再添加什么。
每个功能目录只保留必要说明。没有演示数据、示例论文、预设分析方法或空的依赖锁文件;原始数据、脚本、正文与输出子目录在实际使用时建立。
使用
所有可配置项集中在 .env.example。先复制为 .env,填写工具路径和 NCBI 配置;.env 已被 Git 忽略,未复制时使用模板默认值。
Makefile 识别以下可选入口,文件缺失或内容为空时打印 SKIP,不要求事先安装 R 或 LaTeX。入口存在时,所需工具缺失或执行失败会报错。
这些入口是约定,不提前创建占位脚本。只写论文、暂不分析时,直接添加 manuscript/main.tex 即可;上游空步骤自动跳过。没有正文时也可只运行分析。
默认 LaTeX 使用 latexmk -pdf;需要 XeLaTeX 时运行 make manuscript LATEX_MODE=-xelatex。已有 R 脚本在各次调用时执行,LaTeX 的增量编译由 latexmk 管理。需要精确的分析缓存时,再在 Makefile 中添加真实输出文件与依赖规则。
开始一篇文章
在独立仓库使用此模板,先在 manuscript/ 记录研究问题与分析计划,再按实际任务添加数据、分析与正文。代码放在它服务的功能目录,不按 R、Python、LaTeX 分目录。
出现外部 R 包依赖时再初始化 renv 并提交真实的 renv.lock;记录随机种子和会话信息。可配置项统一维护在 .env.example,实际值放 .env。
文献按章节建立目录,每个论点在章节 README 中记录高级检索式、保存一个含摘要的 .bib;编译前自动生成仅包含正文引用的 reference.bib,引用键冲突即停止。具体格式与保存位置统一见 manuscript/references/README.md。通用 skill 不保存某篇论文的路径与规则。
生成物默认忽略;原始数据的入库与共享按实际权限决定。投稿和打包方案在有真实材料后确定。make clean 只删除 data/derived/、analysis/results/、figures/generated/、manuscript/generated/、manuscript/build/ 和 submission/generated/,并删除自动生成的 reference.bib;各论点的 .bib 会保留。不要在这些位置保存手工材料。
The whole README. Open the repo ↗
Read from the repository's git tree on 2026-08-17.