Skip to content

Commit f2973ae

Browse files
committed
Clarify the use of the shinylive R package
1 parent 3853576 commit f2973ae

File tree

2 files changed

+60
-4
lines changed

2 files changed

+60
-4
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ and [`{quarto-shinylive}`](https://github.com/quarto-ext/shinylive) Quarto exten
55

66
## Installation
77

8-
Please make sure to create a Quarto project and, then, install each extension inside of Terminal:
8+
The installation process requires install **Quarto Extensions** using **Terminal**
9+
and the [`{shinylive}` R package](https://cran.r-project.org/web/packages/shinylive/index.html)
10+
R package for **Shinylive** using the **R console**.
11+
12+
### Quarto Extensions
13+
14+
Please make sure to create a [Quarto project](https://quarto.org/docs/projects/quarto-projects.html) and, then, install each extension inside of Terminal:
915

1016
```sh
1117
# For shinylive
@@ -15,8 +21,30 @@ quarto add quarto-ext/shinylive
1521
quarto add coatless/quarto-webr
1622
```
1723

24+
Both extensions should be found in `_extensions/` within the project directory.
25+
That is, if you navigate to the `_extensions/` folder, you should see:
26+
27+
```default
28+
.
29+
├── _extensions
30+
│ ├── coatless
31+
│ │ └── webr
32+
│ └── quarto-ext
33+
│ └── shinylive
34+
└── quarto-project-in-rstudio.Rproj
35+
```
36+
37+
If not, please double-check your working project directory.
1838

19-
Both extensions should be found in `_extensions` within the project directory. If not, please double-check your working project directory.
39+
40+
### R Package
41+
42+
We need to install the [`{shinylive}` R package](https://cran.r-project.org/web/packages/shinylive/index.html) in order for the `{quarto-shinylive}`
43+
extension to work by typing into R console:
44+
45+
```r
46+
install.packages("shinylive")
47+
```
2048

2149
## Quarto Document
2250

index.qmd

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,13 @@ demo.
7777

7878
## Installation
7979

80-
Please make sure to create a Quarto project and, then, install each extension inside of Terminal:
80+
The installation process requires install **Quarto Extensions** using **Terminal**
81+
and the [`{shinylive}` R package](https://cran.r-project.org/web/packages/shinylive/index.html)
82+
R package for **Shinylive** using the **R console**.
83+
84+
### Quarto Extensions
85+
86+
Please make sure to create a [Quarto project](https://quarto.org/docs/projects/quarto-projects.html) and, then, install each extension inside of Terminal:
8187

8288
```sh
8389
# For shinylive
@@ -87,8 +93,30 @@ quarto add quarto-ext/shinylive
8793
quarto add coatless/quarto-webr
8894
```
8995

96+
Both extensions should be found in `_extensions/` within the project directory.
97+
That is, if you navigate to the `_extensions/` folder, you should see:
98+
99+
```default
100+
.
101+
├── _extensions
102+
│ ├── coatless
103+
│ │ └── webr
104+
│ └── quarto-ext
105+
│ └── shinylive
106+
└── quarto-project-in-rstudio.Rproj
107+
```
108+
109+
If not, please double-check your working project directory.
90110

91-
Both extensions should be found in `_extensions` within the project directory. If not, please double-check your working project directory.
111+
112+
### R Package
113+
114+
We need to install the [`{shinylive}` R package](https://cran.r-project.org/web/packages/shinylive/index.html) in order for the `{quarto-shinylive}`
115+
extension to work by typing into R console:
116+
117+
```r
118+
install.packages("shinylive")
119+
```
92120

93121
## Quarto Document
94122

0 commit comments

Comments
 (0)