diff --git a/README.Rmd b/README.Rmd index 9e1bffb..36915a9 100644 --- a/README.Rmd +++ b/README.Rmd @@ -37,7 +37,13 @@ You can install the development version from [GitHub](https://github.com/rjake/s devtools::install_github("rjake/shinyobjects") ``` ## Usage -The main function of `shinyobjects` is `load_reactive_objects()`. It is similar to running `source()` but with a lot of helpers to give you access to the reactive data. When you run it, your environment will have all your libraries, raw data and assignments, dummy `input`, `output` and `session` lists, and all `reactive()` assignments will be converted to functions. In the dev version (for 0.2.0), you also get access to your `render...()` objects in the dummy `output` list. With the dummy `input` list and the conversion of `reactive(x)` to `function() x`, the code will run your data manipulation referencing your dummy `input` list and it will be like writing a normal script. Note: **shinyobjects does not change your files**; the manipulation happens behind the scenes. +There is a quick tutorial on [YouTube](https://youtu.be/_z_XeXT96Uw) + + + + + +...but in words, the main function of `shinyobjects` is `load_reactive_objects()`. It is similar to running `source()` but with a lot of helpers to give you access to the reactive data. When you run it, your environment will have all your libraries, raw data and assignments, dummy `input`, `output` and `session` lists, and all `reactive()` assignments will be converted to functions. In the dev version (for 0.2.0), you also get access to your `render...()` objects in the dummy `output` list. With the dummy `input` list and the conversion of `reactive(x)` to `function() x`, the code will run your data manipulation referencing your dummy `input` list and it will be like writing a normal script. Note: **shinyobjects does not change your files**; the manipulation happens behind the scenes. diff --git a/README.md b/README.md index 97f567d..1824ea2 100644 --- a/README.md +++ b/README.md @@ -48,17 +48,23 @@ devtools::install_github("rjake/shinyobjects") ## Usage -The main function of `shinyobjects` is `load_reactive_objects()`. It is -similar to running `source()` but with a lot of helpers to give you -access to the reactive data. When you run it, your environment will have -all your libraries, raw data and assignments, dummy `input`, `output` -and `session` lists, and all `reactive()` assignments will be converted -to functions. In the dev version (for 0.2.0), you also get access to -your `render...()` objects in the dummy `output` list. With the dummy -`input` list and the conversion of `reactive(x)` to `function() x`, the -code will run your data manipulation referencing your dummy `input` list -and it will be like writing a normal script. Note: **shinyobjects does -not change your files**; the manipulation happens behind the scenes. +There is a quick tutorial on [YouTube](https://youtu.be/_z_XeXT96Uw) + + + + +…but in words, the main function of `shinyobjects` is +`load_reactive_objects()`. It is similar to running `source()` but with +a lot of helpers to give you access to the reactive data. When you run +it, your environment will have all your libraries, raw data and +assignments, dummy `input`, `output` and `session` lists, and all +`reactive()` assignments will be converted to functions. In the dev +version (for 0.2.0), you also get access to your `render...()` objects +in the dummy `output` list. With the dummy `input` list and the +conversion of `reactive(x)` to `function() x`, the code will run your +data manipulation referencing your dummy `input` list and it will be +like writing a normal script. Note: **shinyobjects does not change your +files**; the manipulation happens behind the scenes. diff --git a/docs/index.html b/docs/index.html index 1f61c7d..23ab2ba 100644 --- a/docs/index.html +++ b/docs/index.html @@ -105,7 +105,9 @@

Usage

-

The main function of shinyobjects is load_reactive_objects(). It is similar to running source() but with a lot of helpers to give you access to the reactive data. When you run it, your environment will have all your libraries, raw data and assignments, dummy input, output and session lists, and all reactive() assignments will be converted to functions. In the dev version (for 0.2.0), you also get access to your render...() objects in the dummy output list. With the dummy input list and the conversion of reactive(x) to function() x, the code will run your data manipulation referencing your dummy input list and it will be like writing a normal script. Note: shinyobjects does not change your files; the manipulation happens behind the scenes.

+

There is a quick tutorial on YouTube

+

+

…but in words, the main function of shinyobjects is load_reactive_objects(). It is similar to running source() but with a lot of helpers to give you access to the reactive data. When you run it, your environment will have all your libraries, raw data and assignments, dummy input, output and session lists, and all reactive() assignments will be converted to functions. In the dev version (for 0.2.0), you also get access to your render...() objects in the dummy output list. With the dummy input list and the conversion of reactive(x) to function() x, the code will run your data manipulation referencing your dummy input list and it will be like writing a normal script. Note: shinyobjects does not change your files; the manipulation happens behind the scenes.

library(shinyobjects)
 
diff --git a/docs/reference/figures/youtube_thumbnail.png b/docs/reference/figures/youtube_thumbnail.png
new file mode 100644
index 0000000..77aeebb
Binary files /dev/null and b/docs/reference/figures/youtube_thumbnail.png differ
diff --git a/man/figures/youtube_thumbnail.png b/man/figures/youtube_thumbnail.png
new file mode 100644
index 0000000..77aeebb
Binary files /dev/null and b/man/figures/youtube_thumbnail.png differ