1
- name: engine
2
  schema:
3
    string:
4
      completions: [jupyter, knitr, julia]
5
  description: "Engine used for executable code blocks."
6

7
- name: jupyter
8
  schema:
9
    anyOf:
10
      - boolean
11
      - string
12
      - object:
13
          hidden: true # don't complete through a single-key object
14
          properties:
15
            kernelspec:
16
              object:
17
                properties:
18
                  display_name:
19
                    string:
20
                      description: The name to display in the UI.
21
                  language:
22
                    string:
23
                      description: The name of the language the kernel implements.
24
                  name:
25
                    string:
26
                      description: The name of the kernel.
27
                required: all
28
  description: Configures the Jupyter engine.
29

30
- name: julia
31
  schema:
32
    object:
33
      properties:
34
        exeflags:
35
          schema:
36
            arrayOf: string
37
            description: Arguments to pass to the Julia worker process.
38
        env:
39
          schema:
40
            arrayOf: string
41
            description: Environment variables to pass to the Julia worker process.
42
  description: Configures the Julia engine.
43

44
- name: knitr
45
  schema:
46
    anyOf:
47
      - boolean
48
      - object:
49
          closed: true
50
          properties:
51
            opts_knit:
52
              object:
53
                description: Knit options.
54
            opts_chunk:
55
              object:
56
                description: Knitr chunk options.
57
  description: Set Knitr options.
58

59
- name: cache
60
  tags:
61
    execute-only: true
62
  schema:
63
    anyOf:
64
      - boolean
65
      - enum: [refresh]
66
  default: false
67
  description:
68
    short: "Cache results of computations."
69
    long: |
70
      Cache results of computations (using the [knitr cache](https://yihui.org/knitr/demo/cache/) 
71
      for R documents, and [Jupyter Cache](https://jupyter-cache.readthedocs.io/en/latest/) 
72
      for Jupyter documents).
73

74
      Note that cache invalidation is triggered by changes in chunk source code 
75
      (or other cache attributes you've defined). 
76

77
      - `true`: Cache results
78
      - `false`: Do not cache results
79
      - `refresh`: Force a refresh of the cache even if has not been otherwise invalidated.
80

81
- name: freeze
82
  tags:
83
    execute-only: true
84
  schema:
85
    anyOf:
86
      - boolean
87
      - enum: [auto]
88
  default: false
89
  description:
90
    short: "Re-use previous computational output when rendering"
91
    long: |
92
      Control the re-use of previous computational output when rendering.
93

94
      - `true`: Never recompute previously generated computational output during a global project render
95
      - `false` (default): Recompute previously generated computational output
96
      - `auto`: Re-compute previously generated computational output only in case their source file changes
97

98
- name: server
99
  hidden: true
100
  schema:
101
    anyOf:
102
      - enum: [shiny]
103
      - object:
104
          properties:
105
            type:
106
              enum: [shiny]
107
              description: Type of server to run behind the document (e.g. `shiny`)
108
            ojs-export:
109
              maybeArrayOf: string
110
              description: OJS variables to export to server.
111
            ojs-import:
112
              maybeArrayOf: string
113
              description: Server reactive values to import into OJS.
114
  description: Document server
115

116
- name: daemon
117
  hidden: true
118
  schema:
119
    anyOf: [number, boolean]
120
  default: 300
121
  description:
122
    short: "Run Jupyter kernels within a peristent daemon (to mitigate kernel startup time)."
123
    long: |
124
      Run Jupyter kernels within a peristent daemon (to mitigate kernel startup time).
125
      By default a daemon with a timeout of 300 seconds will be used. Set `daemon`
126
      to another timeout value or to `false` to disable it altogether.
127

128
- name: daemon-restart
129
  schema: boolean
130
  hidden: true
131
  default: false
132
  description: "Restart any running Jupyter daemon before rendering."
133

134
- name: enabled
135
  schema: boolean
136
  default: true
137
  hidden: true
138
  description: "Enable code cell execution."
139

140
- name: ipynb
141
  schema: boolean
142
  default: false
143
  hidden: true
144
  description: "Execute code cell execution in Jupyter notebooks."
145

146
- name: debug
147
  hidden: true
148
  schema: boolean
149
  default: false
150
  description: "Show code-execution related debug information."
151

152