Skip to content

Commit 3049d33

Browse files
committed
revise replications.md
1 parent 534fed9 commit 3049d33

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

docs/replications.md

+28-17
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,40 @@
1-
This replication package utilizes the [Boa Study
2-
Template](https://github.com/boalang/study-template). If you want to work with
3-
this package beyond simply re-generating the paper's figures and tables, we
4-
**strongly** encourage you to utilize [Visual Studio
1+
/// admonition | This section of the documentation is for people using a replication package built with the Boa Study Template.
2+
type: warning
3+
4+
///
5+
6+
If you downloaded a replication package that utilizes the [Boa Study
7+
Template](https://github.com/boalang/study-template), please continue reading
8+
for more details on how to use that package.
9+
10+
We **strongly** encourage you to utilize [Visual Studio
511
Code](https://code.visualstudio.com/) with the [Boa Language and Infrastructure
6-
Extension](vscode.md) installed. For more information, see [Using the
7-
Template](research/index.md).
12+
Extension](vscode.md) installed. If you have that extension, you can avoid
13+
running terminal commands (like `make`) and instead simply open the
14+
`study-config.json` file to control what files you download, which analyses you
15+
run, etc.
816

9-
If you have that extension, you can avoid running terminal commands (like
10-
`make`) and instead simply open the study-config.json file to control what
11-
files you download, which analyses you run, etc. For more details on working
12-
with Boa's study template, see the [online
13-
documentation](https://github.com/boalang/study-template).
17+
If you plan to extend the replication package, beyond simply re-generating the
18+
paper's figures and tables, you will want to read up on [Using the
19+
Template](research/index.md).
1420

1521
------------------------------------------------------
1622

1723
## Requirements
1824

19-
You need a GNU Make compatible build system. Tested on GNU Make 3.81.
25+
You need a GNU Make compatible build system. Tested on GNU Make 3.81, but
26+
should work with newer versions.
2027

21-
You will also need Python to run the analyses. See the [Python
22-
requirements](requirements.md#python-requirements) for more information.
28+
If you plan to re-run any of the analyses, you will also need Python. See the
29+
[Python requirements](requirements.md#python-requirements) for more
30+
information.
2331

24-
Note that the Boa jobs themselves are marked public, so you do not need a Boa
25-
user to view the actual jobs/output via the website. However, the Boa API
32+
Note that the Boa jobs themselves should be marked public, so you do not need a
33+
Boa user to view the actual jobs/output via the website. However, the Boa API
2634
requires a user/password to use it, so programmatically downloading (even
2735
public jobs) currently requires authenticating. You can, however, manually
2836
download each of the query outputs from the public URLs.
2937

30-
3138
------------------------------------------------------
3239

3340
## Docker Support
@@ -40,6 +47,10 @@ working environment. To build and run the image, run:
4047
make run-docker
4148
```
4249

50+
Once inside the container, you can run the `make reproduce` command to
51+
re-generate the figures and tables from the original paper. This will use the
52+
cached data and should avoid having to download output from Boa.
53+
4354
------------------------------------------------------
4455

4556
## File Organization

0 commit comments

Comments
 (0)