Skip to content

Commit d068896

Browse files
lkrovetzlkrovetz
committed
Updating FAQ to be a grid
1 parent a819d3e commit d068896

3 files changed

Lines changed: 159 additions & 28 deletions

File tree

‎website/faq copy.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "Frequently Asked Questions"
3+
toc: true
4+
permalink: /aea-de-guidance/FAQ.html
5+
layout: single
6+
---
7+
8+
... although some are not frequently asked, but might nevertheless be useful. Below questions and answers in random order. Please be sure to check out the [official list of FAQ](https://www.aeaweb.org/journals/data/faq) first. Should you have other questions not appearing on either page, please [create a new issue on Github](https://github.com/AEADataEditor/aea-de-guidance/issues/new), ask the question on [BlueSky](https://bsky.app/profile/aeadata.bsky.social), or send an email to the [AEA Data Editor](mailto:dataeditor@aeapubs.org).
9+
10+
# Quick Links
11+
12+
| Question | Answer |
13+
|------------|----------------------|
14+
| **Citing, DOI** | |
15+
| What is the DOI of my openICPSR deposit? I have not yet published it, but am asked to add a citation to it in my manuscript? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#what-is-the-doi-of-my-openicpsr-deposit-i-have-not-yet-published-it-but-am-asked-to-add-a-citation-to-it-in-my-manuscript) |
16+
| How do I cite my own data and code supplement? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#how-do-i-cite-my-own-data-and-code-supplement) |
17+
| I have a paper that uses data from 14 different sources. How do I comply with requirement for data citations and fit within page limits? (for instance in Papers and Proceedings) | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-have-a-paper-that-uses-data-from-14-different-sources-how-do-i-comply-with-requirement-for-data-citations-and-fit-within-page-limits-for-instance-in-papers-and-proceedings) |
18+
| **Licensing** | |
19+
| Are authors allowed to reuse the data once the data is published on the AER webpage and what are the specific conditions? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#are-authors-allowed-to-reuse-the-data-once-the-data-is-published-on-the-aer-webpage-and-what-are-the-specific-conditions) |
20+
| **Deposit related** | |
21+
| Should we keep the data and directory structure as we used it ourselves or should we set up the files in a way that would make replication as straightforward as possible? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#should-we-keep-the-data-and-directory-structure-as-we-used-it-ourselves-or-should-we-set-up-the-files-in-a-way-that-would-make-replication-as-straightforward-as-possible) |
22+
| I was asked to modify files in my repository (not yet published) but I cannot upload or edit anything | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-was-asked-to-modify-files-in-my-repository-not-yet-published-but-i-cannot-upload-or-edit-anything) |
23+
| I was wondering whether (and how) I can update the published repository for our paper. I was contacted by a researcher who is doing a replication ... couple of minor issues ... forgotten to include two auxiliary datasets in the repository without which one of the programs does not run successfully. | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-was-wondering-whether-and-how-i-can-update-the-published-repository-for-our-paper-i-was-contacted-by-a-researcher-who-is-doing-a-replication--couple-of-minor-issues--forgotten-to-include-two-auxiliary-datasets-in-the-repository-without-which-one-of-the-programs-does-not-run-successfully) |
24+
| I am trying to upload to the repository, but my replication package has more than 1,000 files | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-am-trying-to-upload-to-the-repository-but-my-replication-package-has-more-than-1000-files) |
25+
| What is that __MACOSX folder, which seems to contain a second copy of all the replication files (I am not sure why this folder exists) | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#what-is-that-__macosx-folder-which-seems-to-contain-a-second-copy-of-all-the--replication-files-i-am-not-sure-why-this-folder-exists) |
26+
| **Confidential data** | |
27+
| The paper uses confidential data, covering [geography] for period [2001-2015]. The repository only contains code. Should the repository metadata be filled out for the data characteristics, even if the repository only has code? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#the-paper-uses-confidential-data-covering-geography-for-period-2001-2015-the-repository-only-contains-code-should-the-repository-metadata-be-filled-out-for-the-data-characteristics-even-if-the-repository-only-has-code)
28+
| I use confidential data. I am allowed to provide the data to the Data Editor for the purpose of replication, but you are not allowed to publish the data. How do I proceed? | [Open](https://www.aeaweb.org/journals/data/faq#confidential) |
29+
| I have been told by the Data Editor to remove PSID data from my submitted materials. What do I do? | [Open](https://www.aeaweb.org/journals/data/faq#psid) |
30+
| **Version control, software, etc.** | |
31+
| We used custom software. How do we describe/provide access to that? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#we-used-custom-software-how-do-we-describeprovide-access-to-that) |
32+
| We already use git/svn/GitHub/GitLab/BitBucket/etc. Do you facilitate integration of existing version-controlled code to the AEA repo? Or even planned functionality for linking out directly to such projects where they can be found online? | [Open](https://www.aeaweb.org/journals/data/faq#existing) |
33+
| Some econometrics papers might be accompanied by (for example) an R or Stata package (perhaps published on CRAN or SSC). What about surfacing references to associated packages more prominently? | [Open](https://www.aeaweb.org/journals/data/faq#package) |
34+
| Do you support Docker/ Jupyter/ etc.? | [Open](https://www.aeaweb.org/journals/data/faq#support) |
35+
| **RCT** | |
36+
| Aligning AEA RCT Registry and AEA Data and Code Repository | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#aligning-aea-rct-registry-and-aea-data-and-code-repository) |
37+
38+

‎website/faq.md‎

Lines changed: 106 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,111 @@ layout: single
77

88
... although some are not frequently asked, but might nevertheless be useful. Below questions and answers in random order. Please be sure to check out the [official list of FAQ](https://www.aeaweb.org/journals/data/faq) first. Should you have other questions not appearing on either page, please [create a new issue on Github](https://github.com/AEADataEditor/aea-de-guidance/issues/new), ask the question on [BlueSky](https://bsky.app/profile/aeadata.bsky.social), or send an email to the [AEA Data Editor](mailto:dataeditor@aeapubs.org).
99

10-
# Quick Links
11-
12-
| Question | Answer |
13-
|------------|----------------------|
14-
| **Citing, DOI** | |
15-
| What is the DOI of my openICPSR deposit? I have not yet published it, but am asked to add a citation to it in my manuscript? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#what-is-the-doi-of-my-openicpsr-deposit-i-have-not-yet-published-it-but-am-asked-to-add-a-citation-to-it-in-my-manuscript) |
16-
| How do I cite my own data and code supplement? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#how-do-i-cite-my-own-data-and-code-supplement) |
17-
| I have a paper that uses data from 14 different sources. How do I comply with requirement for data citations and fit within page limits? (for instance in Papers and Proceedings) | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-have-a-paper-that-uses-data-from-14-different-sources-how-do-i-comply-with-requirement-for-data-citations-and-fit-within-page-limits-for-instance-in-papers-and-proceedings) |
18-
| **Licensing** | |
19-
| Are authors allowed to reuse the data once the data is published on the AER webpage and what are the specific conditions? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#are-authors-allowed-to-reuse-the-data-once-the-data-is-published-on-the-aer-webpage-and-what-are-the-specific-conditions) |
20-
| **Deposit related** | |
21-
| Should we keep the data and directory structure as we used it ourselves or should we set up the files in a way that would make replication as straightforward as possible? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#should-we-keep-the-data-and-directory-structure-as-we-used-it-ourselves-or-should-we-set-up-the-files-in-a-way-that-would-make-replication-as-straightforward-as-possible) |
22-
| I was asked to modify files in my repository (not yet published) but I cannot upload or edit anything | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-was-asked-to-modify-files-in-my-repository-not-yet-published-but-i-cannot-upload-or-edit-anything) |
23-
| I was wondering whether (and how) I can update the published repository for our paper. I was contacted by a researcher who is doing a replication ... couple of minor issues ... forgotten to include two auxiliary datasets in the repository without which one of the programs does not run successfully. | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-was-wondering-whether-and-how-i-can-update-the-published-repository-for-our-paper-i-was-contacted-by-a-researcher-who-is-doing-a-replication--couple-of-minor-issues--forgotten-to-include-two-auxiliary-datasets-in-the-repository-without-which-one-of-the-programs-does-not-run-successfully) |
24-
| I am trying to upload to the repository, but my replication package has more than 1,000 files | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-am-trying-to-upload-to-the-repository-but-my-replication-package-has-more-than-1000-files) |
25-
| What is that __MACOSX folder, which seems to contain a second copy of all the replication files (I am not sure why this folder exists) | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#what-is-that-__macosx-folder-which-seems-to-contain-a-second-copy-of-all-the--replication-files-i-am-not-sure-why-this-folder-exists) |
26-
| **Confidential data** | |
27-
| The paper uses confidential data, covering [geography] for period [2001-2015]. The repository only contains code. Should the repository metadata be filled out for the data characteristics, even if the repository only has code? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#the-paper-uses-confidential-data-covering-geography-for-period-2001-2015-the-repository-only-contains-code-should-the-repository-metadata-be-filled-out-for-the-data-characteristics-even-if-the-repository-only-has-code)
28-
| I use confidential data. I am allowed to provide the data to the Data Editor for the purpose of replication, but you are not allowed to publish the data. How do I proceed? | [Open](https://www.aeaweb.org/journals/data/faq#confidential) |
29-
| I have been told by the Data Editor to remove PSID data from my submitted materials. What do I do? | [Open](https://www.aeaweb.org/journals/data/faq#psid) |
30-
| **Version control, software, etc.** | |
31-
| We used custom software. How do we describe/provide access to that? | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#we-used-custom-software-how-do-we-describeprovide-access-to-that) |
32-
| We already use git/svn/GitHub/GitLab/BitBucket/etc. Do you facilitate integration of existing version-controlled code to the AEA repo? Or even planned functionality for linking out directly to such projects where they can be found online? | [Open](https://www.aeaweb.org/journals/data/faq#existing) |
33-
| Some econometrics papers might be accompanied by (for example) an R or Stata package (perhaps published on CRAN or SSC). What about surfacing references to associated packages more prominently? | [Open](https://www.aeaweb.org/journals/data/faq#package) |
34-
| Do you support Docker/ Jupyter/ etc.? | [Open](https://www.aeaweb.org/journals/data/faq#support) |
35-
| **RCT** | |
36-
| Aligning AEA RCT Registry and AEA Data and Code Repository | [Open](https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#aligning-aea-rct-registry-and-aea-data-and-code-repository) |
10+
::::{grid} 3
3711

12+
:::{grid-item-card} What is the DOI of my openICPSR deposit?
13+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#what-is-the-doi-of-my-openicpsr-deposit-i-have-not-yet-published-it-but-am-asked-to-add-a-citation-to-it-in-my-manuscript
14+
:link-type: url
15+
 
16+
:::
3817

18+
:::{grid-item-card} How do I cite my own data and code supplement?
19+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#how-do-i-cite-my-own-data-and-code-supplement
20+
:link-type: url
21+
 
22+
:::
23+
24+
:::{grid-item-card} I have a paper that uses data from 14 different sources. How do I comply with requirement for data citations and fit within page limits?
25+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-have-a-paper-that-uses-data-from-14-different-sources-how-do-i-comply-with-requirement-for-data-citations-and-fit-within-page-limits-for-instance-in-papers-and-proceedings
26+
:link-type: url
27+
28+
 
29+
:::
30+
31+
:::{grid-item-card} Are authors allowed to reuse the data once the data is published on the AER webpage and what are the specific conditions?
32+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#are-authors-allowed-to-reuse-the-data-once-the-data-is-published-on-the-aer-webpage-and-what-are-the-specific-conditions
33+
:link-type: url
34+
 
35+
:::
36+
37+
38+
:::{grid-item-card} Should we keep the data and directory structure as we used it ourselves or optimize for replication?
39+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#should-we-keep-the-data-and-directory-structure-as-we-used-it-ourselves-or-should-we-set-up-the-files-in-a-way-that-would-make-replication-as-straightforward-as-possible
40+
:link-type: url
41+
 
42+
:::
43+
44+
:::{grid-item-card} I was asked to modify files in my repository but cannot upload or edit anything
45+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-was-asked-to-modify-files-in-my-repository-not-yet-published-but-i-cannot-upload-or-edit-anything
46+
:link-type: url
47+
 
48+
:::
49+
50+
:::{grid-item-card} How can I update a published repository with missing files?
51+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-was-wondering-whether-and-how-i-can-update-the-published-repository-for-our-paper-i-was-contacted-by-a-researcher-who-is-doing-a-replication--couple-of-minor-issues--forgotten-to-include-two-auxiliary-datasets-in-the-repository-without-which-one-of-the-programs-does-not-run-successfully
52+
:link-type: url
53+
 
54+
:::
55+
56+
:::{grid-item-card} My replication package has more than 1,000 files
57+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#i-am-trying-to-upload-to-the-repository-but-my-replication-package-has-more-than-1000-files
58+
:link-type: url
59+
 
60+
:::
61+
62+
:::{grid-item-card} What is the __MACOSX folder?
63+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#what-is-that-__macosx-folder-which-seems-to-contain-a-second-copy-of-all-the--replication-files-i-am-not-sure-why-this-folder-exists
64+
:link-type: url
65+
 
66+
:::
67+
68+
69+
:::{grid-item-card} Should metadata be filled out if repository only contains code?
70+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#the-paper-uses-confidential-data-covering-geography-for-period-2001-2015-the-repository-only-contains-code-should-the-repository-metadata-be-filled-out-for-the-data-characteristics-even-if-the-repository-only-has-code
71+
:link-type: url
72+
 
73+
:::
74+
75+
:::{grid-item-card} I use confidential data. How do I proceed?
76+
:link: https://www.aeaweb.org/journals/data/faq#confidential
77+
:link-type: url
78+
 
79+
:::
80+
81+
:::{grid-item-card} Remove PSID data from submitted materials
82+
:link: https://www.aeaweb.org/journals/data/faq#psid
83+
:link-type: url
84+
 
85+
:::
86+
87+
:::{grid-item-card} We used custom software. How do we provide access?
88+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#we-used-custom-software-how-do-we-describeprovide-access-to-that
89+
:link-type: url
90+
 
91+
:::
92+
93+
:::{grid-item-card} Integration with GitHub / version control systems
94+
:link: https://www.aeaweb.org/journals/data/faq#existing
95+
:link-type: url
96+
 
97+
:::
98+
99+
:::{grid-item-card} Referencing R or Stata packages
100+
:link: https://www.aeaweb.org/journals/data/faq#package
101+
:link-type: url
102+
 
103+
:::
104+
105+
:::{grid-item-card} Support for Docker / Jupyter
106+
:link: https://www.aeaweb.org/journals/data/faq#support
107+
:link-type: url
108+
 
109+
:::
110+
111+
:::{grid-item-card} Aligning AEA RCT Registry and Data Repository
112+
:link: https://aeadataeditor.github.io/aea-de-guidance/FAQ.html#aligning-aea-rct-registry-and-aea-data-and-code-repository
113+
:link-type: url
114+
 
115+
:::
116+
117+
::::

‎website/myst.yml‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,18 @@ site:
8181

8282
parts:
8383
footer: footer.md
84-
84+
85+
myst_enable_extensions:
86+
- colon_fence # required for ::: blocks
87+
- deflist
88+
- html_admonition
89+
- html_image
90+
- linkify
91+
- substitution
92+
- tasklist
93+
- fieldlist
94+
- cards # required for {cards}/{card} directives
95+
96+
cards:
97+
default_columns: 3 # optional, default number of cards per row
98+
gutter: 3

0 commit comments

Comments
 (0)