Improve `run_tutorial()` #601

gadenbuie · 2021-10-15T20:09:42Z

Brings a few new features to run_tutorial():

Allow name to take a path to local tutorial directory. The name must be an existing directory and package must be NULL. Since run_tutorial() manages the tutorial directory and uses the dir argument of rmarkdown::run(), we pre-emptively thorw an error if there is more than one .Rmd in the directory and none are named index.Rmd.
Add arg clean to run_tutorial(), cleanly re-render the tutorial when TRUE. We follow the same logic used in validating the tutorial directory to identify the tutorial .Rmd file, since rmarkdown::shiny_prerendered_clean() requires a specific file rather than a directory.
Launch tutorial in viewer pane by default, if possible. It's not currently possible to open tutorials in the tutorial pane interactively, but by giving launch.browser a function, we have a place to modify this in the future.

Fixes #600
Fixes #333

…hen `TRUE`

rossellhayes

Looks good to me, just a small typo!

R/run.R

tests/testthat/test-run.R

Co-authored-by: Barret Schloerke <[email protected]> Co-authored-by: Alex Rossell Hayes <[email protected]>

gadenbuie · 2021-10-18T16:22:14Z

Update: I also added support, turned on by default, for running a tutorial as a background RStudio job. The tutorial opens wherever shiny apps open by default, using the shiny.launch.browser option.

In theory, we could also open the tutorial in the Tutorials pane, but since there isn't a public API for stopping Rstudio jobs, we'd end up having to build too much infrastructure to achieve parity with the built in tutorial running methods. That's another reason why I decided not to go further; the RStudio tutorial pane depends on run_tutorial() and I'd prefer to avoid a cyclical dependency. The new default for run_tutorial() is to use an RStudio job, but it can be disabled by setting as_rstudio_job = FALSE and it, by default, won't try to run as a job in non-interactive environments (like other RStudio jobs).

We don't directly need this version in learnr code but we might as well encourage learnr users to have the appropriate version

R/run.R

schloerke

Minor changes.

Remove multi-Rmd-file logic warning in available_tutorials_for_package()
Add Breaking Change news item about shiny_args now being after ...

Otherwise LGTM!

Co-authored-by: Barret Schloerke <[email protected]>

…files

and then re-use that logic in `available_tutorials()` and `run_validate_tutorial_path_is_dir()`

gadenbuie

I'm glad I let this sit for a little bit. Coming back to look at it again, I think the restriction that name be a directory when referring to a local file feels too arbitrary.

I stuck with the directory approach because we move the tutorial directory to a temporary location if we don't have write access where the tutorial is stored. That logic makes sense when the tutorial is hosted in an R package, which may be stored in a location that's inaccessible to the end user. But it doesn't make sense for a local file.

I'm going to update the PR to accept a specific file in name. If a file path is provided but the directory isn't writeable, we'll throw an error rather than copy the directory.

Conflicts: NEWS.md R/run.R

…utorial

rossellhayes

This looks good, I just caught a few typos and one potential small improvement

NEWS.md

R/run.R

Co-authored-by: Alex Rossell Hayes <[email protected]>

gadenbuie added 3 commits October 15, 2021 15:54

Allow name to take a path to local tutorial directory

c545bd0

Add arg clean to run_tutorial(), cleanly re-render the tutorial w…

63befda

…hen `TRUE`

Launch tutorial in viewer pane by default, if possible

04f0347

gadenbuie requested a review from schloerke October 15, 2021 20:10

gadenbuie added 2 commits October 15, 2021 16:15

Add tests

19c1520

Slightly better message if shiny prerendered clean fails

3c47090

gadenbuie requested a review from rossellhayes October 15, 2021 20:17

rossellhayes approved these changes Oct 15, 2021

View reviewed changes

R/run.R Outdated Show resolved Hide resolved

schloerke requested changes Oct 15, 2021

View reviewed changes

gadenbuie and others added 9 commits October 15, 2021 16:49

Apply suggestions from code review

bfd8a38

Co-authored-by: Barret Schloerke <[email protected]> Co-authored-by: Alex Rossell Hayes <[email protected]>

Remove trailing slash for file.exists() test on Windows

b0da30e

name can only be a directory when package is NULL

d5d1783

Refactor run_find_tutorial_rmd() and prefix run_ functions

cc87038

Run tutorials as background RStudio jobs

3cd1201

maybe there are multiple trailing slashes

2b61d59

Only remove trailing slash if name is non-null

d677092

Fix typo after variable name change (rmds)

b103e65

Use ASCII unicode for ✓

5dfd6b8

gadenbuie requested review from rossellhayes and schloerke October 18, 2021 16:22

gadenbuie added 3 commits October 18, 2021 12:39

rstudioapi v0.11 added tutorial support

94d5e9e

We don't directly need this version in learnr code but we might as well encourage learnr users to have the appropriate version

Force named shiny_args and check dots are empty

3e43d2b

use substitute/deparse

dbdeee4

schloerke reviewed Oct 18, 2021

View reviewed changes

R/run.R Outdated Show resolved Hide resolved

schloerke reviewed Oct 18, 2021

View reviewed changes

R/run.R Outdated Show resolved Hide resolved

schloerke reviewed Oct 18, 2021

View reviewed changes

R/run.R Outdated Show resolved Hide resolved

schloerke approved these changes Oct 18, 2021

View reviewed changes

gadenbuie and others added 2 commits October 18, 2021 16:39

Apply suggestions from code review

86318bb

Co-authored-by: Barret Schloerke <[email protected]>

Move trailing slash removal to where it's needed

b96256b

gadenbuie added 4 commits October 18, 2021 16:54

Rewrite run_find_tutorial_rmd() to account for additional possible …

0208492

…files

Replicate logic from rmarkdown::run() to find tutorial Rmd

815dc17

and then re-use that logic in `available_tutorials()` and `run_validate_tutorial_path_is_dir()`

Add NEWS for #601

3a91aef

update docs

8b31821

gadenbuie commented Oct 21, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

gadenbuie mentioned this pull request Nov 4, 2021

Is it possible to configure learnr to always forget previous attempts #607

Open

gadenbuie added 4 commits December 28, 2021 11:49

Merge commit branch "main" into "improve-run-tutorial"

09712d2

Conflicts: NEWS.md R/run.R

Refactor run_tutorial() to allow name to point to individual .Rmd t…

63dfa1a

…utorial

update NEWS

d11d93a

Fix remaining reference to tutorial_dir -> tutorial$dir

a7aeb28

gadenbuie force-pushed the improve-run-tutorial branch from 108395d to 8d695fd Compare December 28, 2021 20:18

Add backport for errorCondition on R < 3.6.0

0a52061

gadenbuie force-pushed the improve-run-tutorial branch from 8d695fd to 0a52061 Compare December 28, 2021 20:28

rossellhayes approved these changes Dec 28, 2021

View reviewed changes

NEWS.md Outdated Show resolved Hide resolved

NEWS.md Outdated Show resolved Hide resolved

R/run.R Outdated Show resolved Hide resolved

R/run.R Outdated Show resolved Hide resolved

R/run.R Outdated Show resolved Hide resolved

Apply suggestions from code review

845d9ae

Co-authored-by: Alex Rossell Hayes <[email protected]>

This comment has been minimized.

Sign in to view

gadenbuie and others added 2 commits December 29, 2021 16:14

Document

a432bfd

Normalize directory path when discovering a tutorial file

e63000d

gadenbuie merged commit 7f26e84 into main Dec 29, 2021

gadenbuie deleted the improve-run-tutorial branch December 29, 2021 17:13

schloerke mentioned this pull request Mar 7, 2022

Unify interface with starting application rstudio/shinytest2#127

Closed

Improve run_tutorial() #601

Improve run_tutorial() #601

Uh oh!

Conversation

gadenbuie commented Oct 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rossellhayes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gadenbuie commented Oct 18, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

schloerke left a comment • edited by gadenbuie Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gadenbuie left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

rossellhayes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Improve `run_tutorial()` #601

Improve `run_tutorial()` #601

gadenbuie commented Oct 15, 2021 •

edited

Loading

schloerke left a comment •

edited by gadenbuie

Loading

gadenbuie left a comment •

edited

Loading