CoCalc -- cell-cache.yml

GitHub Repository: quarto-dev/quarto-cli
Path: blob/main/src/resources/schema/cell-cache.yml
¹²⁹²¹ views
1
- name: cache
2
  tags:
3
    engine: knitr
4
  schema: boolean
5
  default: false
6
  description:
7
    short: "Whether to cache a code chunk."
8
    long: |
9
      Whether to cache a code chunk. When evaluating
10
      code chunks for the second time, the cached chunks are skipped (unless they
11
      have been modified), but the objects created in these chunks are loaded from
12
      previously saved databases (`.rdb` and `.rdx` files), and these files are
13
      saved when a chunk is evaluated for the first time, or when cached files are
14
      not found (e.g., you may have removed them by hand). Note that the filename
15
      consists of the chunk label with an MD5 digest of the R code and chunk
16
      options of the code chunk, which means any changes in the chunk will produce
17
      a different MD5 digest, and hence invalidate the cache.
18

19
- name: cache-path
20
  hidden: true
21
  tags:
22
    engine: knitr
23
  schema: path
24
  description: "A prefix to be used to generate the paths of cache files"
25

26
- name: cache-vars
27
  tags:
28
    engine: knitr
29
  schema:
30
    maybeArrayOf: string
31
  description:
32
    short: "Variable names to be saved in the cache database."
33
    long: |
34
      Variable names to be saved in
35
      the cache database. By default, all variables created in the current chunks
36
      are identified and saved, but you may want to manually specify the variables
37
      to be saved, because the automatic detection of variables may not be robust,
38
      or you may want to save only a subset of variables.
39

40
- name: cache-globals
41
  tags:
42
    engine: knitr
43
  schema: string
44
  description:
45
    short: "Variables names that are not created from the current chunk"
46
    long: |
47
      Variables names that are not created from the current chunk.
48

49
      This option is mainly for `autodep: true` to work more precisely---a chunk
50
      `B` depends on chunk `A` when any of `B`'s global variables are `A`'s local 
51
      variables. In case the automatic detection of global variables in a chunk 
52
      fails, you may manually specify the names of global variables via this option.
53
      In addition, `cache-globals: false` means detecting all variables in a code
54
      chunk, no matter if they are global or local variables.
55

56
- name: cache-lazy
57
  tags:
58
    engine: knitr
59
  schema: boolean
60
  default: true
61
  description:
62
    short: "Whether to `lazyLoad()` or directly `load()` objects"
63
    long: |
64
      Whether to `lazyLoad()` or directly `load()` objects. For very large objects, 
65
      lazyloading may not work, so `cache-lazy: false` may be desirable (see
66
      [#572](https://github.com/yihui/knitr/issues/572)).
67

68
- name: cache-rebuild
69
  tags:
70
    engine: knitr
71
  schema: boolean
72
  default: false
73
  description: "Force rebuild of cache for chunk"
74

75
- name: cache-comments
76
  tags:
77
    engine: knitr
78
  schema: boolean
79
  default: true
80
  description: "Prevent comment changes from invalidating the cache for a chunk"
81

82
- name: dependson
83
  tags:
84
    engine: knitr
85
  schema:
86
    anyOf:
87
      - maybeArrayOf: string
88
      - maybeArrayOf: number
89
  description: |
90
    Explicitly specify cache dependencies for this chunk (one or more chunk labels)
91

92
- name: autodep
93
  tags:
94
    engine: knitr
95
  schema: boolean
96
  default: false
97
  description: "Detect cache dependencies automatically via usage of global variables"
98

99
Product

Resources

Company
