5 |
6 |
7 | [](https://www.tidyverse.org/lifecycle/#maturing)
8 | [](https://travis-ci.org/ropensci/insert_table)
9 |
10 |
11 |
12 |
13 | ```{r setup, include = FALSE}
14 | knitr::opts_chunk$set(
15 | collapse = TRUE,
16 | comment = "#>",
17 | fig.path = "man/figures/README-",
18 | out.width = "100%"
19 | )
20 | ```
21 | # inserttable
22 |
23 | `inserttable` is an RStudio add-in facilitating insertion of nicely formatted
24 | tables in R markdown documents or plain R scripts.
25 |
26 | ## Installation
27 |
28 | You can install `inserttable` from [GitHub](https://github.com/lbusett/insert_table)
29 | with:
30 |
31 | ``` r
32 | # install.packages("devtools")
33 | devtools::install_github("lbusett/insert_table")
34 | ```
35 |
36 | ## Usage
37 |
38 | Upon installing, `inserttable` registers a new RStudio Addin (__Insert Table__)
39 | that can be used to easily insert a table in a `Rmd` document. To use it, open a
40 | `Rmd` or `R` document and select "Addins --> Insert Table".
41 |
42 | There are two main __use modes__:
43 |
44 |
45 | ### Launch the addin with the cursor on a empty line
46 |
47 | In this case, a GUI will open allowing you to __select the desired output format__ (
48 | `kable`, `kableExtra`, `DT` and `rhandsontable` are currently implemented), and to __edit the
49 | content of the table__. After clicking __Done__ the Addin will add in the file
50 | the code needed to generate the table in a nice `tribble` format (thanks
51 | to Miles McBain's [`datapasta`](https://github.com/milesmcbain/datapasta) package!)
52 | to allow easier additional editing, and also the code needed to render it with the selected
53 | output format using some default options, as can be seen below:
54 |
55 | __IMPORTANT NOTE:__ Not all output formats play well with knitting to PDF or Word!.
56 | `kable` works everywhere, while `DT` and `rhandsontable` work out of the box only
57 | if knitting to html. You can make them work on PDF and Word by adding
58 | `always_allow_html: yes` in the yaml header of the Rmd, and installing __phantomjs__ using:
59 | `webshot::install_phantomjs()` (results are not that good, though).
60 |
61 | 
62 |
63 |
64 | A useful feature is that, for larger tables, you can also __cut and paste content from a spreadsheet__ :
65 |
66 | 
67 |
68 |
69 | Obviously, rendering of the table can be tweaked further by changing/adding arguments of the rendering functions in the automatically generated code.
70 |
71 |
72 | ### Launch the addin while selecting the name of a variable
73 |
74 | In this case, the GUI allows you to select __only the desired output format__ (
75 | it is assumed that the variable you select corresponds to a `data frame` or similar
76 | object containing the data you wish to show as table). After clicking __Done__
77 | the Addin will add in the `Rmd` document the code needed to render the selected variable as a table with the selected output format. The code will be added at the first empty line below that containing the name of the selected variable.
78 |
79 |
80 | 
81 |
82 |
83 | __IMPORTANT NOTE__: `inserttable` will make no effort to guarantee that the
84 | variable you select is a `data.frame`. It is up to you to select a meaningful
85 | variable!
86 |
87 |
88 | ## Usage from the console
89 |
90 | You can also use (part of) `inserttable` functionality from the console by calling
91 | function `insert_table()`.
92 |
93 | ```{r eval=FALSE, message=FALSE, warning=FALSE, paged.print=FALSE}
94 | > insert_table(tbl_name = "table_1", nrows = 4, ncols = 4, tbl_format = "DT")
95 |
96 | ```
97 |
98 | The function will return __to the console__ the code needed to create a empty
99 | table of the specified dimensions and render it with the selected format:
100 |
101 | 
102 |
103 |
104 |
105 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | inserttable
3 |
4 |
5 |
6 |
7 | [](https://www.tidyverse.org/lifecycle/#maturing)
9 | [](https://travis-ci.org/ropensci/insert_table)
11 |
12 |
13 |
14 |
15 | # inserttable
16 |
17 | `inserttable` is an RStudio add-in facilitating insertion of nicely
18 | formatted tables in R markdown documents or plain R scripts.
19 |
20 | ## Installation
21 |
22 | You can install `inserttable` from
23 | [GitHub](https://github.com/lbusett/insert_table) with:
24 |
25 | ``` r
26 | # install.packages("devtools")
27 | devtools::install_github("lbusett/insert_table")
28 | ```
29 |
30 | ## Usage
31 |
32 | Upon installing, `inserttable` registers a new RStudio Addin (**Insert
33 | Table**) that can be used to easily insert a table in a `Rmd` document.
34 | To use it, open a `Rmd` or `R` document and select “Addins –\> Insert
35 | Table”.
36 |
37 | There are two main **use modes**:
38 |
39 | ### Launch the addin with the cursor on a empty line
40 |
41 | In this case, a GUI will open allowing you to **select the desired
42 | output format** ( `kable`, `kableExtra`, `DT` and `rhandsontable` are
43 | currently implemented), and to **edit the content of the table**. After
44 | clicking **Done** the Addin will add in the file the code needed to
45 | generate the table in a nice `tribble` format (thanks to Miles McBain’s
46 | [`datapasta`](https://github.com/milesmcbain/datapasta) package\!) to
47 | allow easier additional editing, and also the code needed to render it
48 | with the selected output format using some default options, as can be
49 | seen below:
50 |
51 | **IMPORTANT NOTE:** Not all output formats play well with knitting to
52 | PDF or Word\!. `kable` works everywhere, while `DT` and `rhandsontable`
53 | work out of the box only if knitting to html. You can make them work on
54 | PDF and Word by adding `always_allow_html: yes` in the yaml header of
55 | the Rmd, and installing **phantomjs** using:
56 | `webshot::install_phantomjs()` (results are not that good, though).
57 |
58 | 
59 |
60 | A useful feature is that, for larger tables, you can also **cut and
61 | paste content from a spreadsheet** :
62 |
63 | 
64 |
65 | Obviously, rendering of the table can be tweaked further by
66 | changing/adding arguments of the rendering functions in the
67 | automatically generated code.
68 |
69 | ### Launch the addin while selecting the name of a variable
70 |
71 | In this case, the GUI allows you to select **only the desired output
72 | format** ( it is assumed that the variable you select corresponds to a
73 | `data frame` or similar object containing the data you wish to show as
74 | table). After clicking **Done** the Addin will add in the `Rmd` document
75 | the code needed to render the selected variable as a table with the
76 | selected output format. The code will be added at the first empty line
77 | below that containing the name of the selected variable.
78 |
79 | 
80 |
81 | **IMPORTANT NOTE**: `inserttable` will make no effort to guarantee that
82 | the variable you select is a `data.frame`. It is up to you to select a
83 | meaningful variable\!
84 |
85 | ## Usage from the console
86 |
87 | You can also use (part of) `inserttable` functionality from the console
88 | by calling function
89 | `insert_table()`.
90 |
91 | ``` r
92 | > insert_table(tbl_name = "table_1", nrows = 4, ncols = 4, tbl_format = "DT")
93 | ```
94 |
95 | The function will return **to the console** the code needed to create a
96 | empty table of the specified dimensions and render it with the selected
97 | format:
98 |
99 | 
100 |
--------------------------------------------------------------------------------
/_pkgdown.yml:
--------------------------------------------------------------------------------
1 | destination: docs
2 | url: https://lbusett.github.io/insert_table/
3 | template:
4 | params:
5 | bootswatch: spacelab
6 |
--------------------------------------------------------------------------------
/docs/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
67 |
68 |
110 |
111 |
112 |
113 |
114 |
115 |
140 |
141 |
142 |
143 |
144 |
145 |
146 |
147 |
148 |
--------------------------------------------------------------------------------
/docs/Index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
116 |
126 |
127 |
128 |
129 |
139 |
117 |
124 |
125 |
118 |
120 |
121 | Content not found. Please use links in the navbar.
122 |
123 | Page not found (404)
119 |
67 |
68 |
110 |
111 |
112 |
113 |
114 |
115 |
182 |
183 |
184 |
185 |
186 |
187 |
188 |
189 |
190 |
--------------------------------------------------------------------------------
/docs/LICENSE-text.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
116 |
168 |
169 |
170 |
171 |
181 |
117 |
166 |
167 |
118 |
120 |
121 | inserttable
119 |
122 |
123 |
164 |
165 | inserttable is an RStudio add-in facilitating insertion of nicely formatted tables in R markdown documents or plain R scripts.
125 |
131 | 126 | Installation
127 |You can install inserttable from GitHub with:
132 |
154 | 133 | Usage
134 |Upon installing, inserttable registers a new RStudio Addin (Insert Table) that can be used to easily insert a table in a Rmd document. To use it, open a Rmd document and, with the cursor within a r chunk and select “Addins –> Insert Table”.
These are the two main use modes:
136 |
137 |
146 | 138 | Launch the addin with the cursor on a empty line
139 |In this case, a GUI will open allowing you to select the desired output format ( kableExtra, DT and rhandsontable are currently implemented), and to edit the content of the table. After clicking Done the Addin will add in the file the code needed to generate the table in a nice tribble format (thanks to Miles McBain’s datapasta package!) to allow easier additional editing, and also the code needed to render it with the selected output format using some default options, as can be seen below:
IMPORTANT NOTE: Not all output formats play well with knitting to PDF or Word!. kable works everywhere, while DT and rhandsontable work out of the box only if knitting to html. You can make them work on PDF and Word by adding always_allow_html: yes in the yaml header of the Rmd, and installing phantomjs using: webshot::install_phantomjs() (results are not that good, though).
A useful feature is that, for larger tables, you can also cut and paste content from a spreadsheet :
143 |
Obviously, rendering of the table can be tweaked further by changing/adding arguments of the rendering functions in the automatically generated code.
145 |
147 |
153 | 148 | Launch the addin while selecting the name of a variable
149 |In this case, the GUI allows you to select only the desired output format ( it is assumed that the variable you select corresponds to a data frame or similar object containing the data you wish to show as table). After clicking Done the Addin will add in the Rmd document the code needed to render the selected variable as a table with the selected output format. The code will be added at the first empty line below that containing the name of the selected variable.
IMPORTANT NOTE: inserttable will make no effort to guarantee that the variable you select is a data.frame. It is up to you to select a meaningful variable!
155 |
163 | 156 | Usage from the console
157 |You can also use (part of) inserttable functionality from the console by calling function insert_table().
The function will return to the console the code needed to create a empty table of the specified dimensions and render it with the selected format:
161 |
46 |
47 |
97 |
98 |
99 |
100 |
101 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
--------------------------------------------------------------------------------
/docs/apple-touch-icon-120x120.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/apple-touch-icon-120x120.png
--------------------------------------------------------------------------------
/docs/apple-touch-icon-152x152.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/apple-touch-icon-152x152.png
--------------------------------------------------------------------------------
/docs/apple-touch-icon-180x180.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/apple-touch-icon-180x180.png
--------------------------------------------------------------------------------
/docs/apple-touch-icon-60x60.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/apple-touch-icon-60x60.png
--------------------------------------------------------------------------------
/docs/apple-touch-icon-76x76.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/apple-touch-icon-76x76.png
--------------------------------------------------------------------------------
/docs/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/apple-touch-icon.png
--------------------------------------------------------------------------------
/docs/articles/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
102 |
114 |
115 |
116 |
126 |
103 |
112 |
113 |
104 |
106 |
107 | License
105 |YEAR: 2018 108 | COPYRIGHT HOLDER: Lorenzo Busetto 109 |110 | 111 |
46 |
47 |
100 |
101 |
102 |
103 |
104 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
--------------------------------------------------------------------------------
/docs/articles/inserttable.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
105 |
120 |
121 |
131 |
106 |
119 |
107 |
109 |
110 | Articles
108 |
111 |
118 | All vignettes
112 | 113 | 114 |-
115 |
- Vignette Title 116 |
22 |
75 |
76 |
77 |
78 |
325 |
326 |
327 |
328 |
329 |
330 |
--------------------------------------------------------------------------------
/docs/articles/inserttable_files/figure-html/unnamed-chunk-1-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/articles/inserttable_files/figure-html/unnamed-chunk-1-1.png
--------------------------------------------------------------------------------
/docs/articles/inserttable_files/figure-html/unnamed-chunk-1-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/articles/inserttable_files/figure-html/unnamed-chunk-1-2.png
--------------------------------------------------------------------------------
/docs/authors.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
79 |
313 |
314 |
315 |
324 |
80 |
298 |
299 |
311 |
312 |
81 |
89 |
90 |
91 |
92 | Vignette Title
82 |Vignette Author
83 | 84 |2018-04-01
85 | 86 | Source:vignettes/inserttable.Rmd
87 |
88 | Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The html_vignette output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible. The html_vignette format:
-
94 |
- Never uses retina figures 95 |
- Has a smaller default figure size 96 |
- Uses a custom CSS stylesheet instead of the default Twitter Bootstrap style 97 |
99 |
103 | 100 | Vignette Info
101 |Note the various macros within the vignette section of the metadata block above. These are required in order to instruct R how to build the vignette. Note that you should change the title field and the \VignetteIndexEntry to match the title of your vignette.
104 |
111 | 105 | Styles
106 |The html_vignette template includes a basic CSS theme. To override this theme you can specify your own CSS in the document metadata as follows:
output:
108 | rmarkdown::html_vignette:
109 | css: mystyles.css
112 |
117 |
124 | 113 | Figures
114 |The figure sizes have been customised so that you can easily put two images side-by-side.
115 |plot(1:10)
116 | plot(10:1)
You can enable figure captions by fig_caption: yes in YAML:
output:
120 | rmarkdown::html_vignette:
121 | fig_caption: yesThen you can use the chunk option fig.cap = "Your figure caption." in knitr.
125 |
129 |
286 |
291 | 126 | More Examples
127 |You can write math expressions, e.g. \(Y = X\beta + \epsilon\), footnotes1, and tables, e.g. using knitr::kable().
| 131 | | mpg | 132 |cyl | 133 |disp | 134 |hp | 135 |drat | 136 |wt | 137 |qsec | 138 |vs | 139 |am | 140 |gear | 141 |carb | 142 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Mazda RX4 | 146 |21.0 | 147 |6 | 148 |160.0 | 149 |110 | 150 |3.90 | 151 |2.620 | 152 |16.46 | 153 |0 | 154 |1 | 155 |4 | 156 |4 | 157 |
| Mazda RX4 Wag | 160 |21.0 | 161 |6 | 162 |160.0 | 163 |110 | 164 |3.90 | 165 |2.875 | 166 |17.02 | 167 |0 | 168 |1 | 169 |4 | 170 |4 | 171 |
| Datsun 710 | 174 |22.8 | 175 |4 | 176 |108.0 | 177 |93 | 178 |3.85 | 179 |2.320 | 180 |18.61 | 181 |1 | 182 |1 | 183 |4 | 184 |1 | 185 |
| Hornet 4 Drive | 188 |21.4 | 189 |6 | 190 |258.0 | 191 |110 | 192 |3.08 | 193 |3.215 | 194 |19.44 | 195 |1 | 196 |0 | 197 |3 | 198 |1 | 199 |
| Hornet Sportabout | 202 |18.7 | 203 |8 | 204 |360.0 | 205 |175 | 206 |3.15 | 207 |3.440 | 208 |17.02 | 209 |0 | 210 |0 | 211 |3 | 212 |2 | 213 |
| Valiant | 216 |18.1 | 217 |6 | 218 |225.0 | 219 |105 | 220 |2.76 | 221 |3.460 | 222 |20.22 | 223 |1 | 224 |0 | 225 |3 | 226 |1 | 227 |
| Duster 360 | 230 |14.3 | 231 |8 | 232 |360.0 | 233 |245 | 234 |3.21 | 235 |3.570 | 236 |15.84 | 237 |0 | 238 |0 | 239 |3 | 240 |4 | 241 |
| Merc 240D | 244 |24.4 | 245 |4 | 246 |146.7 | 247 |62 | 248 |3.69 | 249 |3.190 | 250 |20.00 | 251 |1 | 252 |0 | 253 |4 | 254 |2 | 255 |
| Merc 230 | 258 |22.8 | 259 |4 | 260 |140.8 | 261 |95 | 262 |3.92 | 263 |3.150 | 264 |22.90 | 265 |1 | 266 |0 | 267 |4 | 268 |2 | 269 |
| Merc 280 | 272 |19.2 | 273 |6 | 274 |167.6 | 275 |123 | 276 |3.92 | 277 |3.440 | 278 |18.30 | 279 |1 | 280 |0 | 281 |4 | 282 |4 | 283 |
Also a quote using >:
288 |290 |“He who gives up [code] safety for [code] speed deserves neither.” (via)
289 |
292 |
293 |
297 | 293 |
-
294 |
A footnote here.↩
295 |
67 |
68 |
110 |
111 |
112 |
113 |
114 |
115 |
145 |
146 |
147 |
148 |
149 |
150 |
151 |
152 |
153 |
--------------------------------------------------------------------------------
/docs/docsearch.css:
--------------------------------------------------------------------------------
1 | /* Docsearch -------------------------------------------------------------- */
2 | /*
3 | Source: https://github.com/algolia/docsearch/
4 | License: MIT
5 | */
6 |
7 | .algolia-autocomplete {
8 | display: block;
9 | -webkit-box-flex: 1;
10 | -ms-flex: 1;
11 | flex: 1
12 | }
13 |
14 | .algolia-autocomplete .ds-dropdown-menu {
15 | width: 100%;
16 | min-width: none;
17 | max-width: none;
18 | padding: .75rem 0;
19 | background-color: #fff;
20 | background-clip: padding-box;
21 | border: 1px solid rgba(0, 0, 0, .1);
22 | box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175);
23 | }
24 |
25 | @media (min-width:768px) {
26 | .algolia-autocomplete .ds-dropdown-menu {
27 | width: 175%
28 | }
29 | }
30 |
31 | .algolia-autocomplete .ds-dropdown-menu::before {
32 | display: none
33 | }
34 |
35 | .algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] {
36 | padding: 0;
37 | background-color: rgb(255,255,255);
38 | border: 0;
39 | max-height: 80vh;
40 | }
41 |
42 | .algolia-autocomplete .ds-dropdown-menu .ds-suggestions {
43 | margin-top: 0
44 | }
45 |
46 | .algolia-autocomplete .algolia-docsearch-suggestion {
47 | padding: 0;
48 | overflow: visible
49 | }
50 |
51 | .algolia-autocomplete .algolia-docsearch-suggestion--category-header {
52 | padding: .125rem 1rem;
53 | margin-top: 0;
54 | font-size: 1.3em;
55 | font-weight: 500;
56 | color: #00008B;
57 | border-bottom: 0
58 | }
59 |
60 | .algolia-autocomplete .algolia-docsearch-suggestion--wrapper {
61 | float: none;
62 | padding-top: 0
63 | }
64 |
65 | .algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {
66 | float: none;
67 | width: auto;
68 | padding: 0;
69 | text-align: left
70 | }
71 |
72 | .algolia-autocomplete .algolia-docsearch-suggestion--content {
73 | float: none;
74 | width: auto;
75 | padding: 0
76 | }
77 |
78 | .algolia-autocomplete .algolia-docsearch-suggestion--content::before {
79 | display: none
80 | }
81 |
82 | .algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header {
83 | padding-top: .75rem;
84 | margin-top: .75rem;
85 | border-top: 1px solid rgba(0, 0, 0, .1)
86 | }
87 |
88 | .algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column {
89 | display: block;
90 | padding: .1rem 1rem;
91 | margin-bottom: 0.1;
92 | font-size: 1.0em;
93 | font-weight: 400
94 | /* display: none */
95 | }
96 |
97 | .algolia-autocomplete .algolia-docsearch-suggestion--title {
98 | display: block;
99 | padding: .25rem 1rem;
100 | margin-bottom: 0;
101 | font-size: 0.9em;
102 | font-weight: 400
103 | }
104 |
105 | .algolia-autocomplete .algolia-docsearch-suggestion--text {
106 | padding: 0 1rem .5rem;
107 | margin-top: -.25rem;
108 | font-size: 0.8em;
109 | font-weight: 400;
110 | line-height: 1.25
111 | }
112 |
113 | .algolia-autocomplete .algolia-docsearch-footer {
114 | width: 110px;
115 | height: 20px;
116 | z-index: 3;
117 | margin-top: 10.66667px;
118 | float: right;
119 | font-size: 0;
120 | line-height: 0;
121 | }
122 |
123 | .algolia-autocomplete .algolia-docsearch-footer--logo {
124 | background-image: url("data:image/svg+xml;utf8,");
125 | background-repeat: no-repeat;
126 | background-position: 50%;
127 | background-size: 100%;
128 | overflow: hidden;
129 | text-indent: -9000px;
130 | width: 100%;
131 | height: 100%;
132 | display: block;
133 | transform: translate(-8px);
134 | }
135 |
136 | .algolia-autocomplete .algolia-docsearch-suggestion--highlight {
137 | color: #FF8C00;
138 | background: rgba(232, 189, 54, 0.1)
139 | }
140 |
141 |
142 | .algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
143 | box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5)
144 | }
145 |
146 | .algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content {
147 | background-color: rgba(192, 192, 192, .15)
148 | }
149 |
--------------------------------------------------------------------------------
/docs/docsearch.js:
--------------------------------------------------------------------------------
1 | $(function() {
2 |
3 | // register a handler to move the focus to the search bar
4 | // upon pressing shift + "/" (i.e. "?")
5 | $(document).on('keydown', function(e) {
6 | if (e.shiftKey && e.keyCode == 191) {
7 | e.preventDefault();
8 | $("#search-input").focus();
9 | }
10 | });
11 |
12 | $(document).ready(function() {
13 | // do keyword highlighting
14 | /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */
15 | var mark = function() {
16 |
17 | var referrer = document.URL ;
18 | var paramKey = "q" ;
19 |
20 | if (referrer.indexOf("?") !== -1) {
21 | var qs = referrer.substr(referrer.indexOf('?') + 1);
22 | var qs_noanchor = qs.split('#')[0];
23 | var qsa = qs_noanchor.split('&');
24 | var keyword = "";
25 |
26 | for (var i = 0; i < qsa.length; i++) {
27 | var currentParam = qsa[i].split('=');
28 |
29 | if (currentParam.length !== 2) {
30 | continue;
31 | }
32 |
33 | if (currentParam[0] == paramKey) {
34 | keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20"));
35 | }
36 | }
37 |
38 | if (keyword !== "") {
39 | $(".contents").unmark({
40 | done: function() {
41 | $(".contents").mark(keyword);
42 | }
43 | });
44 | }
45 | }
46 | };
47 |
48 | mark();
49 | });
50 | });
51 |
52 | /* Search term highlighting ------------------------------*/
53 |
54 | function matchedWords(hit) {
55 | var words = [];
56 |
57 | var hierarchy = hit._highlightResult.hierarchy;
58 | // loop to fetch from lvl0, lvl1, etc.
59 | for (var idx in hierarchy) {
60 | words = words.concat(hierarchy[idx].matchedWords);
61 | }
62 |
63 | var content = hit._highlightResult.content;
64 | if (content) {
65 | words = words.concat(content.matchedWords);
66 | }
67 |
68 | // return unique words
69 | var words_uniq = [...new Set(words)];
70 | return words_uniq;
71 | }
72 |
73 | function updateHitURL(hit) {
74 |
75 | var words = matchedWords(hit);
76 | var url = "";
77 |
78 | if (hit.anchor) {
79 | url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor;
80 | } else {
81 | url = hit.url + '?q=' + escape(words.join(" "));
82 | }
83 |
84 | return url;
85 | }
86 |
--------------------------------------------------------------------------------
/docs/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/favicon-16x16.png
--------------------------------------------------------------------------------
/docs/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/favicon-32x32.png
--------------------------------------------------------------------------------
/docs/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lbusett/insert_table/034080d9138b6afbf09af32593d850614dae79b7/docs/favicon.ico
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
116 |
131 |
132 |
133 |
134 |
144 |
117 |
129 |
130 |
118 |
120 |
121 | Authors
119 |-
122 |
-
123 |
Lorenzo Busetto. Author, maintainer.
125 |
124 |
126 |
32 |
75 |
76 |
77 |
78 |
79 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
--------------------------------------------------------------------------------
/docs/jquery.sticky-kit.min.js:
--------------------------------------------------------------------------------
1 | /*
2 | Sticky-kit v1.1.2 | WTFPL | Leaf Corcoran 2015 | http://leafo.net
3 | */
4 | (function(){var b,f;b=this.jQuery||window.jQuery;f=b(window);b.fn.stick_in_parent=function(d){var A,w,J,n,B,K,p,q,k,E,t;null==d&&(d={});t=d.sticky_class;B=d.inner_scrolling;E=d.recalc_every;k=d.parent;q=d.offset_top;p=d.spacer;w=d.bottoming;null==q&&(q=0);null==k&&(k=void 0);null==B&&(B=!0);null==t&&(t="is_stuck");A=b(document);null==w&&(w=!0);J=function(a,d,n,C,F,u,r,G){var v,H,m,D,I,c,g,x,y,z,h,l;if(!a.data("sticky_kit")){a.data("sticky_kit",!0);I=A.height();g=a.parent();null!=k&&(g=g.closest(k));
5 | if(!g.length)throw"failed to find stick parent";v=m=!1;(h=null!=p?p&&a.closest(p):b(""))&&h.css("position",a.css("position"));x=function(){var c,f,e;if(!G&&(I=A.height(),c=parseInt(g.css("border-top-width"),10),f=parseInt(g.css("padding-top"),10),d=parseInt(g.css("padding-bottom"),10),n=g.offset().top+c+f,C=g.height(),m&&(v=m=!1,null==p&&(a.insertAfter(h),h.detach()),a.css({position:"",top:"",width:"",bottom:""}).removeClass(t),e=!0),F=a.offset().top-(parseInt(a.css("margin-top"),10)||0)-q,
6 | u=a.outerHeight(!0),r=a.css("float"),h&&h.css({width:a.outerWidth(!0),height:u,display:a.css("display"),"vertical-align":a.css("vertical-align"),"float":r}),e))return l()};x();if(u!==C)return D=void 0,c=q,z=E,l=function(){var b,l,e,k;if(!G&&(e=!1,null!=z&&(--z,0>=z&&(z=E,x(),e=!0)),e||A.height()===I||x(),e=f.scrollTop(),null!=D&&(l=e-D),D=e,m?(w&&(k=e+u+c>C+n,v&&!k&&(v=!1,a.css({position:"fixed",bottom:"",top:c}).trigger("sticky_kit:unbottom"))),e
80 |
165 |
166 |
167 |
176 |
81 |
82 |
131 |
132 |
164 | inserttable 
87 |
89 |
129 |
130 | inserttable is an RStudio add-in facilitating insertion of nicely formatted tables in R markdown documents or plain R scripts.
91 |
97 | 92 | Installation
93 |You can install inserttable from GitHub with:
98 |
120 | 99 | Usage
100 |Upon installing, inserttable registers a new RStudio Addin (Insert Table) that can be used to easily insert a table in a Rmd document. To use it, open a Rmd or R document and select “Addins –> Insert Table”.
There are two main use modes:
102 |
103 |
112 | 104 | Launch the addin with the cursor on a empty line
105 |In this case, a GUI will open allowing you to select the desired output format ( kable, kableExtra, DT and rhandsontable are currently implemented), and to edit the content of the table. After clicking Done the Addin will add in the file the code needed to generate the table in a nice tribble format (thanks to Miles McBain’s datapasta package!) to allow easier additional editing, and also the code needed to render it with the selected output format using some default options, as can be seen below:
IMPORTANT NOTE: Not all output formats play well with knitting to PDF or Word!. kable works everywhere, while DT and rhandsontable work out of the box only if knitting to html. You can make them work on PDF and Word by adding always_allow_html: yes in the yaml header of the Rmd, and installing phantomjs using: webshot::install_phantomjs() (results are not that good, though).
A useful feature is that, for larger tables, you can also cut and paste content from a spreadsheet :
109 |
Obviously, rendering of the table can be tweaked further by changing/adding arguments of the rendering functions in the automatically generated code.
111 |
113 |
119 | 114 | Launch the addin while selecting the name of a variable
115 |In this case, the GUI allows you to select only the desired output format ( it is assumed that the variable you select corresponds to a data frame or similar object containing the data you wish to show as table). After clicking Done the Addin will add in the Rmd document the code needed to render the selected variable as a table with the selected output format. The code will be added at the first empty line below that containing the name of the selected variable.
IMPORTANT NOTE: inserttable will make no effort to guarantee that the variable you select is a data.frame. It is up to you to select a meaningful variable!
121 |
128 | 122 | Usage from the console
123 |You can also use (part of) inserttable functionality from the console by calling function insert_table().
The function will return to the console the code needed to create a empty table of the specified dimensions and render it with the selected format:
126 |
67 |
68 |
110 |
111 |
112 |
113 |
114 |
115 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
--------------------------------------------------------------------------------
/docs/pkgdown.css:
--------------------------------------------------------------------------------
1 | /* Sticky footer */
2 |
3 | /**
4 | * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
5 | * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
6 | *
7 | * .Site -> body > .container
8 | * .Site-content -> body > .container .row
9 | * .footer -> footer
10 | *
11 | * Key idea seems to be to ensure that .container and __all its parents__
12 | * have height set to 100%
13 | *
14 | */
15 |
16 | html, body {
17 | height: 100%;
18 | }
19 |
20 | body > .container {
21 | display: flex;
22 | height: 100%;
23 | flex-direction: column;
24 | }
25 |
26 | body > .container .row {
27 | flex: 1 0 auto;
28 | }
29 |
30 | footer {
31 | margin-top: 45px;
32 | padding: 35px 0 36px;
33 | border-top: 1px solid #e5e5e5;
34 | color: #666;
35 | display: flex;
36 | flex-shrink: 0;
37 | }
38 | footer p {
39 | margin-bottom: 0;
40 | }
41 | footer div {
42 | flex: 1;
43 | }
44 | footer .pkgdown {
45 | text-align: right;
46 | }
47 | footer p {
48 | margin-bottom: 0;
49 | }
50 |
51 | img.icon {
52 | float: right;
53 | }
54 |
55 | img {
56 | max-width: 100%;
57 | }
58 |
59 | /* Fix bug in bootstrap (only seen in firefox) */
60 | summary {
61 | display: list-item;
62 | }
63 |
64 | /* Typographic tweaking ---------------------------------*/
65 |
66 | .contents .page-header {
67 | margin-top: calc(-60px + 1em);
68 | }
69 |
70 | /* Section anchors ---------------------------------*/
71 |
72 | a.anchor {
73 | margin-left: -30px;
74 | display:inline-block;
75 | width: 30px;
76 | height: 30px;
77 | visibility: hidden;
78 |
79 | background-image: url(./link.svg);
80 | background-repeat: no-repeat;
81 | background-size: 20px 20px;
82 | background-position: center center;
83 | }
84 |
85 | .hasAnchor:hover a.anchor {
86 | visibility: visible;
87 | }
88 |
89 | @media (max-width: 767px) {
90 | .hasAnchor:hover a.anchor {
91 | visibility: hidden;
92 | }
93 | }
94 |
95 |
96 | /* Fixes for fixed navbar --------------------------*/
97 |
98 | .contents h1, .contents h2, .contents h3, .contents h4 {
99 | padding-top: 60px;
100 | margin-top: -40px;
101 | }
102 |
103 | /* Sidebar --------------------------*/
104 |
105 | #sidebar {
106 | margin-top: 30px;
107 | position: -webkit-sticky;
108 | position: sticky;
109 | top: 70px;
110 | }
111 | #sidebar h2 {
112 | font-size: 1.5em;
113 | margin-top: 1em;
114 | }
115 |
116 | #sidebar h2:first-child {
117 | margin-top: 0;
118 | }
119 |
120 | #sidebar .list-unstyled li {
121 | margin-bottom: 0.5em;
122 | }
123 |
124 | .orcid {
125 | height: 16px;
126 | /* margins are required by official ORCID trademark and display guidelines */
127 | margin-left:4px;
128 | margin-right:4px;
129 | vertical-align: middle;
130 | }
131 |
132 | /* Reference index & topics ----------------------------------------------- */
133 |
134 | .ref-index th {font-weight: normal;}
135 |
136 | .ref-index td {vertical-align: top;}
137 | .ref-index .icon {width: 40px;}
138 | .ref-index .alias {width: 40%;}
139 | .ref-index-icons .alias {width: calc(40% - 40px);}
140 | .ref-index .title {width: 60%;}
141 |
142 | .ref-arguments th {text-align: right; padding-right: 10px;}
143 | .ref-arguments th, .ref-arguments td {vertical-align: top;}
144 | .ref-arguments .name {width: 20%;}
145 | .ref-arguments .desc {width: 80%;}
146 |
147 | /* Nice scrolling for wide elements --------------------------------------- */
148 |
149 | table {
150 | display: block;
151 | overflow: auto;
152 | }
153 |
154 | /* Syntax highlighting ---------------------------------------------------- */
155 |
156 | pre {
157 | word-wrap: normal;
158 | word-break: normal;
159 | border: 1px solid #eee;
160 | }
161 |
162 | pre, code {
163 | background-color: #f8f8f8;
164 | color: #333;
165 | }
166 |
167 | pre code {
168 | overflow: auto;
169 | word-wrap: normal;
170 | white-space: pre;
171 | }
172 |
173 | pre .img {
174 | margin: 5px 0;
175 | }
176 |
177 | pre .img img {
178 | background-color: #fff;
179 | display: block;
180 | height: auto;
181 | }
182 |
183 | code a, pre a {
184 | color: #375f84;
185 | }
186 |
187 | a.sourceLine:hover {
188 | text-decoration: none;
189 | }
190 |
191 | .fl {color: #1514b5;}
192 | .fu {color: #000000;} /* function */
193 | .ch,.st {color: #036a07;} /* string */
194 | .kw {color: #264D66;} /* keyword */
195 | .co {color: #888888;} /* comment */
196 |
197 | .message { color: black; font-weight: bolder;}
198 | .error { color: orange; font-weight: bolder;}
199 | .warning { color: #6A0366; font-weight: bolder;}
200 |
201 | /* Clipboard --------------------------*/
202 |
203 | .hasCopyButton {
204 | position: relative;
205 | }
206 |
207 | .btn-copy-ex {
208 | position: absolute;
209 | right: 0;
210 | top: 0;
211 | visibility: hidden;
212 | }
213 |
214 | .hasCopyButton:hover button.btn-copy-ex {
215 | visibility: visible;
216 | }
217 |
218 | /* headroom.js ------------------------ */
219 |
220 | .headroom {
221 | will-change: transform;
222 | transition: transform 200ms linear;
223 | }
224 | .headroom--pinned {
225 | transform: translateY(0%);
226 | }
227 | .headroom--unpinned {
228 | transform: translateY(-100%);
229 | }
230 |
231 | /* mark.js ----------------------------*/
232 |
233 | mark {
234 | background-color: rgba(255, 255, 51, 0.5);
235 | border-bottom: 2px solid rgba(255, 153, 51, 0.3);
236 | padding: 1px;
237 | }
238 |
239 | /* vertical spacing after htmlwidgets */
240 | .html-widget {
241 | margin-bottom: 10px;
242 | }
243 |
244 | /* fontawesome ------------------------ */
245 |
246 | .fab {
247 | font-family: "Font Awesome 5 Brands" !important;
248 | }
249 |
250 | /* don't display links in code chunks when printing */
251 | /* source: https://stackoverflow.com/a/10781533 */
252 | @media print {
253 | code a:link:after, code a:visited:after {
254 | content: "";
255 | }
256 | }
257 |
--------------------------------------------------------------------------------
/docs/pkgdown.js:
--------------------------------------------------------------------------------
1 | /* http://gregfranko.com/blog/jquery-best-practices/ */
2 | (function($) {
3 | $(function() {
4 |
5 | $('.navbar-fixed-top').headroom();
6 |
7 | $('body').css('padding-top', $('.navbar').height() + 10);
8 | $(window).resize(function(){
9 | $('body').css('padding-top', $('.navbar').height() + 10);
10 | });
11 |
12 | $('body').scrollspy({
13 | target: '#sidebar',
14 | offset: 60
15 | });
16 |
17 | $('[data-toggle="tooltip"]').tooltip();
18 |
19 | var cur_path = paths(location.pathname);
20 | var links = $("#navbar ul li a");
21 | var max_length = -1;
22 | var pos = -1;
23 | for (var i = 0; i < links.length; i++) {
24 | if (links[i].getAttribute("href") === "#")
25 | continue;
26 | // Ignore external links
27 | if (links[i].host !== location.host)
28 | continue;
29 |
30 | var nav_path = paths(links[i].pathname);
31 |
32 | var length = prefix_length(nav_path, cur_path);
33 | if (length > max_length) {
34 | max_length = length;
35 | pos = i;
36 | }
37 | }
38 |
39 | // Add class to parent
116 |
163 |
164 |
165 |
175 |
117 |
149 |
150 |
161 |
162 |
118 |
121 |
122 | Changelog
119 | Source:NEWS.md
120 |
123 |
127 | 124 | inserttable 0.1
125 |Fix insertion of code in Rmd (Fixes #5)
126 |
128 |
136 |
141 |
148 | 129 | inserttable 0.0.2
130 |-
131 |
- Now also working in plain “.R” files to support use in
knitr::spin132 |
133 | - Added possibility to provide user defined table name in the GUI 134 |
69 |
70 |
112 |
113 |
114 |
115 |
116 |
117 |
183 |
184 |
185 |
186 |
187 |
188 |
189 |
190 |
191 |
--------------------------------------------------------------------------------
/docs/reference/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
118 |
170 |
171 |
172 |
182 |
119 |
124 |
125 |
134 |
152 |
153 |
159 |
169 |
126 |
129 |
130 | Accessory function used to generate the code needed to generate 127 | the table in the selected output format
128 |get_table_code(out_tbl, is_console, context)131 | 132 |
Arguments
133 || out_tbl | 137 |`list` passed from `insert_table` and containing 4 elements: 138 | 1: data.frame to be used to generate the table, 2: context of the call, 139 | 3: column names (optional) and 4: table name |
140 |
|---|---|
| is_console | 143 |`logical` if TRUE, the insert_table function was called 144 | from the console, otherwise from an Rmd file using the addin |
145 |
| context | 148 |context of the call (tells if from console or file, and if 149 | from file allows to retrieve the lines, etcetera) |
150 |
Value
154 | 155 |returns the code needed to generate the table, either by creating 156 | new lines in the Rmd, or by printing it to the console (if is.console = TRUE)
157 | 158 |
67 |
68 |
110 |
111 |
112 |
113 |
114 |
115 |
160 |
161 |
162 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
--------------------------------------------------------------------------------
/docs/reference/insert_table.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
72 |
73 |
115 |
116 |
117 |
118 |
119 |
120 |
222 |
223 |
224 |
225 |
226 |
227 |
228 |
229 |
230 |
--------------------------------------------------------------------------------
/docs/sitemap.txt:
--------------------------------------------------------------------------------
1 | http://lbusett.github.io/insert_table/reference/insert_table.html
2 |
--------------------------------------------------------------------------------
/docs/sitemap.xml:
--------------------------------------------------------------------------------
1 |
2 |
121 |
209 |
210 |
211 |
221 |
122 |
127 |
128 |
141 |
169 |
170 |
197 |
208 |
129 |
135 |
136 | Function and RStudio add-in allowing to quickly and automatically 130 | generate the code needed to render a table in a RMarkdown document using different 131 | formats (kable, kableExtra, DT and rhandsontable are currently implemented - if "None" 132 | is selected only the code to generate a new tibble with the provided content 133 | is provided).
134 |insert_table(nrows = 3, ncols = 3, tbl_format = "kable", 137 | tbl_name = "my_tbl", colnames = NULL)138 | 139 |
Arguments
140 || nrows | 144 |`numeric` number of rows of the generated empty table, Default: 1 145 | (ignored if calling the addin from an empty Rmd line) |
146 |
|---|---|
| ncols | 149 |`numeric` number of columns of the generated empty table, Default: 1 150 | (ignored if calling the addin from an empty Rmd line) |
151 |
| tbl_format | 154 |`character` [`kable` | `kableExtra - html` | `kableExtra - pdf` | 155 | `DT` | `rhandsontable` | `None`] format 156 | required for the table to be created (ignored if calling as an addin) |
157 |
| tbl_name | 160 |`character` name required for the table to be created 161 | (ignored if calling as an addin) |
162 |
| colnames | 165 |`character` of length ncols containing the desired column names 166 | (ignored if calling as an addin) |
167 |
Value
171 | 172 |returns the code required to create a table in a Rmd file with the
173 | required format.
174 | When calling as an add-in:
175 | * if the call is done when the cursor is on a empty selection the user can
176 | enter also the number of rows and columns and the code to generate a empty
177 | tribble with the specified dimensions is also created;
178 | * if the call is done when the cursor is on a non-empty selection the user can
179 | only select the output format, and the add-in returns the code needed to
180 | create a table named as the selected text, with the specified format
When called as a function: 182 | * the code to generate a empty tribble with the specified dimensions is 183 | created (defaults are used if any parameter is not passed), followed by 184 | the code needed to create a table with the specified format. The results 185 | are sent back to the console.
186 | 187 |Examples
188 |196 |if (FALSE) { 189 | # From the console, use: 190 | insert_table(nrows = 4, ncols = 3, tbl_format = "DT") 191 | 192 | # From a "Rmd" file and within RStudio, place the cursor on a empty line or 193 | # select the name a data.frame within a "R" chunk, then click on "Addins" 194 | # and select "Insert Table" 195 | }