run_tuner {autoharp}R Documentation

Runs the student-facing feedback app

Description

This function runs the shiny app that students submit to in order to obtain feedback on their Rmd submission file.

Usage

run_tuner(
  app_title,
  soln_templates_dir,
  knit_wd,
  tabs = c("lint", "html", "correctness"),
  lint_list,
  corr_cols_to_drop = c(1, 2, 4, 5),
  max_time = 120,
  summary_header = "# Summary Output",
  permission_to_install = FALSE,
  ...
)

Arguments

app_title

A character string of the title of the app.

soln_templates_dir

This should be the directory containing all solution templates. Solution templates are Rmd files.

knit_wd

The working directory for knitting (to HTML).

tabs

A character vector of type of check to be done

lint_list

A list of lints (from lintr package) to be run on the uploaded script. If missing, a default list of lints is run. See the details section.

corr_cols_to_drop

This should be an integer vector of columns to drop from the correctness check. By default, the columns corresponding to filename, timestamp, run-time timing and memory are dropped.

max_time

The maximum time (in seconds) allocated to rendering before failing. This is passed on to render_one.

summary_header

This the header to search for when generating the description for the correctness check.

permission_to_install

This is the argument to toggle for auto installation of libraries. Default is set to FALSE.

...

Extra arguments passed on to runApp from shiny. Useful for specifying port, etc.

Details

If the lint_list argument is missing, the following list of lints is run:

  1. T_and_F_symbol_linter,

  2. assignment_linter,

  3. closed_curly_linter,

  4. commas_linter,

  5. equals_na_linter,

  6. function_left_parentheses_linter,

  7. infix_spaces_linter,

  8. line_length_linter,

  9. no_tab_linter,

  10. open_curly_linter,

  11. paren_brace_linter,

  12. absolute_path_linter,

  13. pipe_continuation_linter,

  14. spaces_inside_linter,

  15. trailing_blank_lines_linter,

  16. trailing_whitespace_linter,

  17. unneeded_concatenation_linter

The full list of available lints can be found here: linters.

Value

This function is run for its side-effect.


[Package autoharp version 0.0.8 Index]