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

Commit

Permalink
Add cliMode
Browse files Browse the repository at this point in the history
  • Loading branch information
ShixiangWang committed Feb 5, 2021
1 parent 5429787 commit 5ddda55
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The contents of `helloworld.R`:
# @param add_line export::extra::switch::{"default": true, "class":"col-12"}
# en: Add Line
# zh: 添加线图
# @return ggplot::["pdf", "png"]::{"title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
# @return ggplot::["pdf", "png"]::{"cliMode": true, "title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
# @data
# # You can write the code to generate the example data
# # 'data.txt' described in parameter data, or you can
Expand Down Expand Up @@ -144,7 +144,7 @@ This section I will briefly describe supported tags, for more information, pleas
- `<output-type>::<output-format>::<output-setting>`
- `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).
- `output-format` sets the figure output format like PDF, PNG, etc.
- `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.
- `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).
- `@data`: many line, it contains code to generate example data described in data table parameters (**Optional**).

### More Examples
Expand Down
2 changes: 1 addition & 1 deletion examples/helloworld.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
# @param add_line export::extra::switch::{"default": true, "class":"col-12"}
# en: Add Line
# zh: 添加线图
# @return ggplot::["pdf", "png"]::{"title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
# @return ggplot::["pdf", "png"]::{"cliMode": true, "title": "A test plot", "width":4, "height": 4, "theme": "theme_bw"}
# @data
# # You can write the code to generate the example data
# # 'data.txt' described in parameter data, or you can
Expand Down

0 comments on commit 5ddda55

Please sign in to comment.