-
Notifications
You must be signed in to change notification settings - Fork 0
/
input-format.Rmd
203 lines (120 loc) · 6.27 KB
/
input-format.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
---
title: Input Format
---
`andrew` tries to support a wide range of input formats for content.
Each piece of content is represented by a Git repository **and** a file.
In the abstence of a file, the `README.md` should be used.
# Supported formats
## `README.md`
Example: https://github.com/GESIS-Methods-Hub/minimal-example-readme
This should be used **only** as a fallback.
### Required
- [ ] Markdown file named `README.md`
- [ ] Heading level 1 in the `README.md`
- [ ] Author name in Git commit information
### Desired
- [ ] Image (900×600 pixels) named `cover.jpg` or `cover.svg` to use as cover
## (Pandoc) Markdown
Example: https://github.com/GESIS-Methods-Hub/minimal-example-md
This is an expansion of John Gruber's [Markdown](https://daringfireball.net/projects/markdown/) syntax that supports tables, citation, ...
### Required
- [ ] Markdown file named `index.md` or another name except `README.md`
- [ ] YAML header block at the begin of the Markdown file defining
- `title`
- `author`
### Desired
- [ ] Complete author details, including affiliation
- [ ] Image (900×600 pixels) to use as cover and associated metadata in the YAML header block at the begin of the Markdown file defining
- `image`
- `image-alt`
## Quarto (document)
Example: https://github.com/GESIS-Methods-Hub/minimal-example-qmd-rstats-units
Quarto is based on Pandoc Markdown and adds support to executable code blocks.
### Required
- [ ] Markdown file named `index.qmd` or another name except `README.qmd`
- [ ] YAML header block at the begin of the Markdown file defining
- `title`
- `author`
- [ ] Configuration files for `repo2docker` to use when installing dependencies
### Desired
- [ ] Complete author details, including affiliation
- [ ] Image (900×600 pixels) to use as cover and associated metadata in the YAML header block at the begin of the Markdown file defining
- `image`
- `image-alt`
## Jupyter Notebook (using Quarto extension)
Example: https://github.com/GESIS-Methods-Hub/minimal-example-ipynb-python
Markdown cells in the Jupyter Notebook **must** use Quarto Markdown instead of [Jupyter Notebook Markdown](https://jupyterbook.org/en/stable/file-types/markdown.html) (based on [CommonMark Markdown](https://commonmark.org/)) and [MyST Markdown](https://mystmd.org/).
### Required
- [ ] Markdown file named `index.ipynb` or another name except `README.ipynb`
- [ ] YAML header block in the first cell of the Jupyter Notebook defining
- `title`
- `author`
The cell **must be** of type `raw`.
- [ ] Configuration files for `repo2docker` to use when installing dependencies
### Desired
- [ ] Complete author details, including affiliation
- [ ] Image (900×600 pixels) to use as cover and associated metadata in the YAML header block in the first cell of the Jupyter Notebook defining
- `image`
- `image-alt`
The cell **must be** of type `raw`.
## Python Package
See [`README.md` section](#readm-me).
## R Package
See [`README.md` section](#readm-me).
## R Package (with `pkgdown` website)
Example: https://github.com/GESIS-Methods-Hub/minimal-example-rstats-package
### Required
- [ ] `DESCRIPTION` file with metadata of the R package
- [ ] R Markdown file named `vignettes/*.Rmd` or another name except `README.md`
- [ ] YAML header block at the begin of the Markdown file defining
- `title`
- `author`
- [ ] Additional configuration files for `repo2docker` to use when installing dependencies
### Desired
- [ ] Complete author details, including affiliation
- [ ] Image (900×600 pixels) to use as cover and associated metadata in the YAML header block at the begin of the Markdown file defining
- `image`
- `image-alt`
## R Shiny App
Example: https://github.com/GESIS-Methods-Hub/minimal-example-shiny-rstats
### Required
- [ ] `app.R` file with the logic of the R Shiny app
- [ ] Markdown file named `index.md` or another name except `README.md`
- [ ] YAML header block at the begin of the Markdown file defining
- `title`
- `author`
- [ ] Configuration files for `repo2docker` to use when installing dependencies
### Desired
- [ ] Complete author details, including affiliation
- [ ] Image (900×600 pixels) to use as cover and associated metadata in the YAML header block at the begin of the Markdown file defining
- `image`
- `image-alt`
## Microsoft Office Word 2007 (DOCX) - Guide
Example: https://github.com/GESIS-Methods-Hub/minimal-guide-example-docx
### Required
- [ ] Microsoft Office Word 2007 file named `index.md` or another name
- [ ] Title using [style](https://support.microsoft.com/en-us/office/apply-styles-f8b96097-4d25-4fac-8200-6139c8093109) `Title`
- [ ] One author name per paragrah using the [style](https://support.microsoft.com/en-us/office/apply-styles-f8b96097-4d25-4fac-8200-6139c8093109 `Author`.
### Desired
- [ ] Image named `cover.jpg` or `cover.svg` to use as cover
## Microsoft Office Word 2007 (DOCX) - Interview
Example: https://github.com/GESIS-Methods-Hub/minimal-interview-example-docx
### Required
- [ ] Microsoft Office Word 2007 file named `index.md` or another name
- [ ] Title using [style](https://support.microsoft.com/en-us/office/apply-styles-f8b96097-4d25-4fac-8200-6139c8093109 `Title`
- [ ] One author name per paragrah using the [style](https://support.microsoft.com/en-us/office/apply-styles-f8b96097-4d25-4fac-8200-6139c8093109 `Author`.
### Desired
- [ ] Image (900×600 pixels) named `cover.jpg` or `cover.svg` to use as cover
# Unsupported formats (yet)
## Quarto (book)
**Not supported yet**. Visit https://github.com/GESIS-Methods-Hub/andrew/issues/119 for updates.
## Markedly Structured Text (MyST)
**Not supported yet**. Visit https://github.com/GESIS-Methods-Hub/andrew/issues/59 for updates.
Example: https://github.com/GESIS-Methods-Hub/minimal-example-myst
## Jupyter Notebook (using MyST extension)
**Not supported yet**. Visit https://github.com/GESIS-Methods-Hub/andrew/issues/59 for updates.
Example: https://github.com/GESIS-Methods-Hub/minimal-example-ipynb-myst-python
## Jupyter book
**Not supported yet**. Visit https://github.com/GESIS-Methods-Hub/andrew/issues/120 for updates.
## Python Package (with Sphinx website)
**Not supported yet**. Visit https://github.com/GESIS-Methods-Hub/andrew/issues/121 for updates.