如何确保模拟结果和论文中的结果始终保持同步？

在我的一篇论文中，我列出了一些数字结果以及一些数字。我想做的是确保论文中的数值结果始终与代码一致。现在，我只是将模拟结果的数值结果直接复制到纸张中，这非常简单且技术含量低，但容易出错，因为我可能会错误地复制结果，或者忘记将纸张结果与代码输出。

有没有一种很好的方法可以使我在论文中引用的数值结果与我的代码生成的结果保持同步？（在这里，我认为执行代码很容易且实用，只要我想更新论文即可。）这些数值结果不一定适合表格形式。有时，手稿中有表格，但更常见的是，我在方程式中将仿真参数列为数字。例如：

我想替换初始条件y ∗的元素$\mathbf{y}^{*}$用实际参数我在模拟中使用了实际参数，该模拟对常微分方程组进行了数值积分。使用一个表来处理一次性数据（例如本例）似乎是多余的，而且墨水过多。

我认为数字是一种更简单的情况：只要“构建”文档（从LaTeX源，Markdown，RST等），就可以通过执行代码来开始构建过程。但是，如果人们有更好的建议可以使模拟生成的图形与我的论文保持同步，那么我很乐意听到它们。

正如一些评论所建议的那样，这种方法在R社区中早已建立Sweave并发展了knitr。显然，这种方法目前具有特定于语言的缺点，但其优点是经常在学术论文中使用。

在实际出版物中使用Sweave

• 该杂志的生物统计学鼓励这些意见，并把一个风筝标志字母“R”的学术论文，其中重现性编辑器已经能够运行的代码和数据，并得到了这些结果。
• 基本上，R-Journal中的所有出版物都基于Sweave。

当然，更常见的是，Sweave / knitr用户只将最终输出提交给大多数期刊，并确信这些方法确实可以复制结果。同样，sweave通常用于创建用于专业演讲等的幻灯片。

有用的功能

为了在实践中有用，这种系统应具有某些功能。随着大量用户的使用，其中许多人已经发展成熟knitr。一些要点：

• 正在缓存。以诸如markdown或Latex之类的格式编写，必须对其进行编译才能查看输出，这使得当无法缓存结果时，无法包括其中的代码。knitr实际上，聪明的缓存实际上使调试密集型代码比使用pure容易得多R，因为不必重新运行成功的块。

• 切换代码显示。在正式出版物中，可能不希望任何基础代码在输出中可见。同时，当您希望读者确切看到您正在键入的内容时，以输出格式显示生成结果的（格式正确，语法突出显示）的代码通常很有价值。

• 社区。与自制解决方案相比，这种方法最引人注目的优势是熟悉该模型并试图对其进行改进的人员数量。

• 在knitr网页演示中可以找到许多其他功能的漂亮示例，包括“轻量级发布”或在网络上共享的工具。这些功能中的许多功能有助于使该方法与人的一般工作流程更加兼容，而不是仅在撰写稿件时要做的事情。

历史脚注。

顾名思义，它扎根于Knuth的“文学编程”，但重点却大不相同，因为文学编程专注于连接软件代码和文档（在R社区中，角色由扮演Roxygen，其根源可追溯至）的不同分支。 “识字编程树”）。

超越

原则上，我们可能会向动态文档提出更多要求，例如读者具有更改输入和查看输出的能力，而无需编辑和重新编译整个文档（例如，使用交互式在线平台）。 XDynDocs可能是朝这个方向迈出的一步。

其他方法

• 可能希望关注dexy.it
• 用一种稍微不同的方法：越来越多的经济学论文托管与http://www.runmycode.org/上的出版物关联的代码，这些代码将在云上重新运行分析，并允许自定义输入参数或自定义输入数据。

您需要的是“可执行文件”的Elsivier挑战。尽管尝试了许多方法，但没有一种方法能像作者建议的那样令人信服。以下是一些使用的技术示例。

马达加斯加计划（Madagascar Project）采用您的方法，在制作脚本内运行模拟，以同时生成图形和纸张。

IPython Notebook提供了一个文档，您可以在阅读该文档时执行该文档，并制作出令人心动的图形。（我已经看到了单词插件，Mathematica和以相同方式使用的许多其他解决方案）

VisTrails使用面向服务的体系结构方法，并提供“ ”或“工作流”管理器。基本上，您注册钩子以进行编码，然后设计可重现您的工作的工作流程或实验。它已用于许多类型的代码，甚至是HPC集群。使用这种方法，您将可以重播实验。

那里有大量此类解决方案，但我印象深刻的是其中的三个。这是一个艰巨的问题，我相信我们真的还没有解决。我们甚至无法让人们随他们的论文一起发布他们的代码，我们如何期望他们重现结果= P

在使用其他人的解决方案来解决这个问题上，我并没有取得很大的成功。我通常只希望一些简单的东西对我有用，并能完成工作。为此，我通常尝试编写一个python脚本，该脚本负责运行所有结果，解析输出以及构建图形/表格。

我编写代码以生成包含某些文本格式结果的数据文件。您可以通过先测试输出文件的存在来避免在脚本中重新运行这些结果（例如，在python中使用os.path.isfile（））。如果要重新运行结果，只需删除数据文件。如果数据文件存在，那么我将运行这些文件的解析器。为此，用于正则表达式的python模块非常有用（重新）。

然后从解析的输出中创建图或表。对于乳胶中的表格，您可以编写代码以将表格生成到单独的文件中（我使用.tbl扩展名），然后将其包含在乳胶文件中。他们的关键是要使用1个python脚本。如果我有很多人，那我以后会怀疑是哪个，他们做什么。如果这个描述太含糊，我可以给你举一些例子。

在我看来，更重要的是确保您能弄清楚如何在一个月或一年内从头开始重新生成所有结果（例如，当裁判员要求您添加或修改某些内容时）。为此，我要做的是包括一个文本文件，其中包含有关如何重现所有结果的非常详细的说明。最好是让其他人（例如合著者）尝试一下以进行测试。我建议您还将这些说明（以及所有代码）提供给裁判和读者。

这是一个示例（实际上是我的合著者阿隆·艾哈迈迪亚（Aron Ahmadia）准备的）。

Emacs的orgmode与Babel结合实现了这一目标。Babel可以执行来自各种编程和脚本语言的代码片段，例如，它可以打开包含模拟数据的文件，并将其放入orgmode表中，然后可以导出为LaTeX（以及许多其他格式）。习惯组织模式中的所有关键组合需要花费相当长的时间，但是一旦运行，一切都会自动进行。

如果运行所有代码都很便宜，则可以执行以下低技术操作：

您可以使用带格式的字符串将文档模板化，以便它们看起来像这样

"we observed a %(fractional_improvement)s increase in ..."

有看起来像这样的python脚本

results = {"alpha"                  : run_alpha_computation(...),
           "fractional_improvement" : run_fi_computation(...), 
           ...}

然后做这样的事情

for fn in filenames:
    file = open(fn);      s = file.read();       file.close()
    file = open(fn, 'w'); file.write(s%results); file.close()

然后，您可以将其包装在Makefile中。

如果您使用的是LaTeX，则技术含量较低的解决方案是让您的代码吐出一个文件（或者使用脚本从代码输出中进行过滤），该文件包含以下几行代码：

\newcommand{\myresults1}{<value>}

然后，您可以使用\input命令将该文件添加到文档中，并使用定义的命令放置值。

我为爱思唯尔工作。我的公司已开始在期刊问题中使用Collage框架（为响应Executable Paper Grand Challenge而开发），以使作者能够在其文章中发布大块可执行代码。此功能使读者可以更轻松地复制文章中报告的结果，并将已出版的材料重新用于自己的研究。Collage支持多种开源和专有软件；可以在此处的参考视频和Collage Authoring Environment网站中找到更多信息。