Skip to content
This repository was archived by the owner on Apr 10, 2022. It is now read-only.

Commit 5ddda55

Browse files
committed
Add cliMode
1 parent 5429787 commit 5ddda55

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The contents of `helloworld.R`:
6262
# @param add_line export::extra::switch::{"default": true, "class":"col-12"}
6363
# en: Add Line
6464
# zh: 添加线图
65-
# @return ggplot::["pdf", "png"]::{"title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
65+
# @return ggplot::["pdf", "png"]::{"cliMode": true, "title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
6666
# @data
6767
# # You can write the code to generate the example data
6868
# # 'data.txt' described in parameter data, or you can
@@ -144,7 +144,7 @@ This section I will briefly describe supported tags, for more information, pleas
144144
- `<output-type>::<output-format>::<output-setting>`
145145
- `output-type` (JSON format) can be `ggplot`, `plot` (for plots not generated by ggplot) and `directory` (outputing a whole directory, you need read docs for more).
146146
- `output-format` sets the figure output format like PDF, PNG, etc.
147-
- `output-setting` (JSON format) corresponds to default general parameters in a plot which provided in Hiplot UI but cannot be mapped to parameters of the main functions, like `title`, `palette`, `theme`, `width` and `height` of the plot, etc.
147+
- `output-setting` (JSON format) corresponds to default general parameters in a plot which provided in Hiplot UI but cannot be mapped to parameters of the main functions, like `title`, `palette`, `theme`, `width` and `height` of the plot, etc. (`cliMode` is suggested enable, it works faster for simple plugin).
148148
- `@data`: many line, it contains code to generate example data described in data table parameters (**Optional**).
149149

150150
### More Examples

examples/helloworld.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
# @param add_line export::extra::switch::{"default": true, "class":"col-12"}
3333
# en: Add Line
3434
# zh: 添加线图
35-
# @return ggplot::["pdf", "png"]::{"title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
35+
# @return ggplot::["pdf", "png"]::{"cliMode": true, "title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
3636
# @data
3737
# # You can write the code to generate the example data
3838
# # 'data.txt' described in parameter data, or you can

0 commit comments

Comments
 (0)