SuperAPI AI 工具集

jfqa-replication-and-data-policy

写作与研究

查看项目

更新于 10-15 20:09

技能介绍

用途:帮助作者按 JFQA Code Sharing Policy 打包代码与数据归档。该政策对 2024 年 1 月 1 日及以后投稿且被录用的论文为强制要求,更早投稿为自愿;材料在录用后、在线发表前发布。最终打包前应重新核对最新政策。

需提交内容:能由原始数据复现全部报告结果(每张表、每个图)的源代码;原始数据集,若受版权或保密限制(如 CRSP、Compustat、TAQ 等),则提交观测数量足以让所有程序成功运行的伪数据集;read-me 文件,说明软件、语言、数据格式,并在有多个程序时给出执行顺序路线图。

归档位置:作为补充材料存入 JFQA Dataverse(托管于 Harvard University Dataverse)。代码仅限学术研究使用,使用者须注明代码来源。

例外:任何例外(如延迟共享代码)必须在初次投稿时提出,之后不再受理;由责任编辑决定,获批例外会在已发表论文中注明。

验证:JFQA 可能对随机抽取的论文使用外部验证服务检查代码,因此归档应能让第三方从(原始或伪)数据端到端运行。

构建规范:用一个主脚本(run_all)从所存数据重新生成全部展示项;固定软件与包版本,为 bootstrap/仿真设置并报告随机种子;使用相对路径;确保伪数据集触发所有代码路径。

许可数据源的伪数据做法:CRSP、Compustat、TAQ、IBES、OptionMetrics 抽取数据不可再分发,伪数据承担验证职责——保留完全相同的模式(变量名、类型、面板键如 permno/gvkey/date),使合并无需改动即可运行;模拟或打乱足够行数(例如 500 家公司、120 个月,按设计缩放)以覆盖每种合并、筛选和边界情况(缺失退市收益、重复链接、零成交量日、财年变更);在伪数据上跑完整流程,确认每个程序完成、每个展示项以格式正确(数值不必相同)的形式生成;在 read-me 中明确说明伪数据数值不会与论文一致,并列出验证者复现真实结果所需的许可抽取信息(数据供应商、库/表名、变量清单、查询日期范围)。

归档布局与试运行:目录含 README.md(软件与版本、数据清单、执行路线图)、run_all.sh(一键重建全部表图)、code/(编号如 01_build_sample、02_main_tables)、data/raw/ 或 data/pseudo/、output/tables/ 与 output/figures/。在干净目录(最好在同事机器上)复制归档,运行 run_all,并将重新生成的展示项与稿件比对。确认 read-me 写明仅限学术研究许可及须注明代码来源。由于验证可能由外部服务对随机抽取论文执行,read-me 应面向毫无背景的陌生人撰写。

例外决策参考:标准 WRDS 源(CRSP/Compustat/TAQ)用伪数据集加完整代码,无需例外;NDA 下的专有数据(券商、交易所、银行)用伪数据集并申请延迟/有限共享,须在初次投稿时提出;公开文件手工收集数据直接存原始数据;条款可协商的商业数据应尽早询问供应商,默认用伪数据,仅在确实无法共享时申请例外。

输出格式: 【Code】reproduces all tables/figures from raw data? [Y/N] 【Data】raw OR pseudo dataset that runs end-to-end? [which] 【Read-me】software/versions + execution roadmap? [Y/N] 【Deposit】JFQA Dataverse (Harvard), academic-use license? [Y/N] 【Exception】needed? if so, requested at INITIAL submission? [Y/N/NA] 【Next step】jfqa-submission