Skip to content

Commit

Permalink
Add youtube thumbnail (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
rjake authored Jul 28, 2020
1 parent be06ea6 commit 4b9a3a2
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 13 deletions.
8 changes: 7 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<a href="https://youtu.be/_z_XeXT96Uw">
<img src="man/figures/youtube_thumbnail.png">
</a>

...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.

<img src="man/figures/load_reactive_objects.png" width=600/>

Expand Down
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<a href="https://youtu.be/_z_XeXT96Uw">
<img src="man/figures/youtube_thumbnail.png"> </a>

…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.

<img src="man/figures/load_reactive_objects.png" width=600/>

Expand Down
4 changes: 3 additions & 1 deletion docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added docs/reference/figures/youtube_thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/figures/youtube_thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4b9a3a2

Please sign in to comment.