diff --git a/404.html b/404.html index a4051f8..0a0b40b 100644 --- a/404.html +++ b/404.html @@ -20,7 +20,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/LICENSE-text.html b/LICENSE-text.html index af3ec78..8d094f2 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/LICENSE.html b/LICENSE.html index baa063b..140ad00 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/authors.html b/authors.html index 6e90be7..db3595b 100644 --- a/authors.html +++ b/authors.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 @@ -60,14 +60,14 @@ Citation Maksymiuk S, Kelkhoff D (2024). checked: Systematically Run R CMD Checks. -R package version 0.2.4, +R package version 0.2.5, https://github.com/Genentech/checked, https://Genentech.github.io/checked/. @Manual{, title = {checked: Systematically Run R CMD Checks}, author = {Szymon Maksymiuk and Doug Kelkhoff}, year = {2024}, - note = {R package version 0.2.4, + note = {R package version 0.2.5, https://github.com/Genentech/checked}, url = {https://Genentech.github.io/checked/}, } diff --git a/index.html b/index.html index a788e64..1b48631 100644 --- a/index.html +++ b/index.html @@ -22,7 +22,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/news/index.html b/news/index.html index 4fad517..6251762 100644 --- a/news/index.html +++ b/news/index.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 @@ -38,6 +38,10 @@ Changelog Source: NEWS.md + +checked 0.2.5 +Refine reverse suggested dependecy strategy. + checked 0.2.4CRAN release: 2024-10-25 Fix check processes hanging forever in some system configurations. diff --git a/pkgdown.yml b/pkgdown.yml index 63a1f40..70c9ad2 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.1 pkgdown_sha: ~ articles: {} -last_built: 2024-10-28T16:09Z +last_built: 2024-11-13T16:43Z urls: reference: https://Genentech.github.io/checked/reference article: https://Genentech.github.io/checked/articles diff --git a/reference/DB_COLNAMES.html b/reference/DB_COLNAMES.html index 452a8e6..b214a27 100644 --- a/reference/DB_COLNAMES.html +++ b/reference/DB_COLNAMES.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/DEP.html b/reference/DEP.html index e2737e1..09086fa 100644 --- a/reference/DEP.html +++ b/reference/DEP.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/DEP_STRONG.html b/reference/DEP_STRONG.html index 7671a58..889b0a7 100644 --- a/reference/DEP_STRONG.html +++ b/reference/DEP_STRONG.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/STATUS.html b/reference/STATUS.html index a7f3cff..b4f8b0f 100644 --- a/reference/STATUS.html +++ b/reference/STATUS.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/ansi.html b/reference/ansi.html index f603ed5..a29d414 100644 --- a/reference/ansi.html +++ b/reference/ansi.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/check_design.html b/reference/check_design.html index a493a21..4a7e707 100644 --- a/reference/check_design.html +++ b/reference/check_design.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/check_dev_rev_deps.html b/reference/check_dev_rev_deps.html index af3f546..ccea0c6 100644 --- a/reference/check_dev_rev_deps.html +++ b/reference/check_dev_rev_deps.html @@ -15,7 +15,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/check_dir.html b/reference/check_dir.html index e42b924..30c8d37 100644 --- a/reference/check_dir.html +++ b/reference/check_dir.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/check_functions.html b/reference/check_functions.html index 786ab71..e193a0d 100644 --- a/reference/check_functions.html +++ b/reference/check_functions.html @@ -15,7 +15,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/check_pkgs.html b/reference/check_pkgs.html index 26960c6..40eaf95 100644 --- a/reference/check_pkgs.html +++ b/reference/check_pkgs.html @@ -11,7 +11,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/check_rev_deps.html b/reference/check_rev_deps.html index bc153b2..ef835c0 100644 --- a/reference/check_rev_deps.html +++ b/reference/check_rev_deps.html @@ -11,7 +11,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/check_task_spec.html b/reference/check_task_spec.html index 12343c7..b975cac 100644 --- a/reference/check_task_spec.html +++ b/reference/check_task_spec.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/checked-task-df.html b/reference/checked-task-df.html index 9530511..ec1e92d 100644 --- a/reference/checked-task-df.html +++ b/reference/checked-task-df.html @@ -13,7 +13,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/checks_capture.html b/reference/checks_capture.html index 08318cf..96396d7 100644 --- a/reference/checks_capture.html +++ b/reference/checks_capture.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/checks_simplify.html b/reference/checks_simplify.html index eb399cc..f0acb8a 100644 --- a/reference/checks_simplify.html +++ b/reference/checks_simplify.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/cli.html b/reference/cli.html index 20bf2f5..fe4f367 100644 --- a/reference/cli.html +++ b/reference/cli.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/custom_install_task_spec.html b/reference/custom_install_task_spec.html index a974bb7..d98abef 100644 --- a/reference/custom_install_task_spec.html +++ b/reference/custom_install_task_spec.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/devnull.html b/reference/devnull.html index 4e6c3cd..93a20c5 100644 --- a/reference/devnull.html +++ b/reference/devnull.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/index.html b/reference/index.html index 641d8e5..6825a3a 100644 --- a/reference/index.html +++ b/reference/index.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/install_task_spec.html b/reference/install_task_spec.html index e4689ff..177faf2 100644 --- a/reference/install_task_spec.html +++ b/reference/install_task_spec.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/new_check_design.html b/reference/new_check_design.html index c21ce46..4155d1f 100644 --- a/reference/new_check_design.html +++ b/reference/new_check_design.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/options.html b/reference/options.html index 92b4fb4..5ff8d29 100644 --- a/reference/options.html +++ b/reference/options.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/options_params.html b/reference/options_params.html index d2d0a7e..53aa207 100644 --- a/reference/options_params.html +++ b/reference/options_params.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/package_spec.html b/reference/package_spec.html index 5c16a6c..a9598d8 100644 --- a/reference/package_spec.html +++ b/reference/package_spec.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/print.checked_results.html b/reference/print.checked_results.html index 8f64939..daba8c3 100644 --- a/reference/print.checked_results.html +++ b/reference/print.checked_results.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/reporters-internal.html b/reference/reporters-internal.html index 57346cb..f12328c 100644 --- a/reference/reporters-internal.html +++ b/reference/reporters-internal.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/reporters.html b/reference/reporters.html index f4326ab..bbd9942 100644 --- a/reference/reporters.html +++ b/reference/reporters.html @@ -15,7 +15,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/results.html b/reference/results.html index 3670d47..57cf826 100644 --- a/reference/results.html +++ b/reference/results.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/results_to_file.html b/reference/results_to_file.html index ddbc83c..035748d 100644 --- a/reference/results_to_file.html +++ b/reference/results_to_file.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/rev_dep_check_tasks_df.html b/reference/rev_dep_check_tasks_df.html index 2f35fa2..ac3ec61 100644 --- a/reference/rev_dep_check_tasks_df.html +++ b/reference/rev_dep_check_tasks_df.html @@ -13,7 +13,7 @@ checked - 0.2.4 + 0.2.5 @@ -58,6 +58,7 @@ Usage path, repos = getOption("repos"), versions = c("dev", "release"), + lib.loc = .libPaths(), ... ) @@ -86,6 +87,11 @@ Argumentslib.loc +vector of libraries used to check whether reverse dependency +check can return accurate results. + + ... parameters passed to the task specs allowing to customize subprocesses. diff --git a/reference/revdep_check_task_spec.html b/reference/revdep_check_task_spec.html index 1149fef..634ecb9 100644 --- a/reference/revdep_check_task_spec.html +++ b/reference/revdep_check_task_spec.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/run.html b/reference/run.html index 339aca0..c21e841 100644 --- a/reference/run.html +++ b/reference/run.html @@ -13,7 +13,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/silent_spinner.html b/reference/silent_spinner.html index a65f539..4234430 100644 --- a/reference/silent_spinner.html +++ b/reference/silent_spinner.html @@ -13,7 +13,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/source_check_tasks_df.html b/reference/source_check_tasks_df.html index 81380c6..8fc2bb6 100644 --- a/reference/source_check_tasks_df.html +++ b/reference/source_check_tasks_df.html @@ -13,7 +13,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/task_graph_create.html b/reference/task_graph_create.html index 4cb89c2..f1e8f99 100644 --- a/reference/task_graph_create.html +++ b/reference/task_graph_create.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/task_graph_neighborhoods.html b/reference/task_graph_neighborhoods.html index 8e65396..a6ac4cf 100644 --- a/reference/task_graph_neighborhoods.html +++ b/reference/task_graph_neighborhoods.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/task_graph_sort.html b/reference/task_graph_sort.html index 659e921..9852a27 100644 --- a/reference/task_graph_sort.html +++ b/reference/task_graph_sort.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/task_graph_which_satisfied.html b/reference/task_graph_which_satisfied.html index 898a6e1..f315f22 100644 --- a/reference/task_graph_which_satisfied.html +++ b/reference/task_graph_which_satisfied.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/task_spec.html b/reference/task_spec.html index 34978a5..e8c4473 100644 --- a/reference/task_spec.html +++ b/reference/task_spec.html @@ -9,7 +9,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/reference/throttle.html b/reference/throttle.html index e8e4a0c..fd30bde 100644 --- a/reference/throttle.html +++ b/reference/throttle.html @@ -7,7 +7,7 @@ checked - 0.2.4 + 0.2.5 diff --git a/search.json b/search.json index f2faa38..2448c68 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://Genentech.github.io/checked/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 checked authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://Genentech.github.io/checked/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Szymon Maksymiuk. Maintainer, author. Doug Kelkhoff. Author. F. Hoffmann-La Roche AG. Copyright holder, funder.","code":""},{"path":"https://Genentech.github.io/checked/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Maksymiuk S, Kelkhoff D (2024). checked: Systematically Run R CMD Checks. R package version 0.2.4, https://github.com/Genentech/checked, https://Genentech.github.io/checked/.","code":"@Manual{, title = {checked: Systematically Run R CMD Checks}, author = {Szymon Maksymiuk and Doug Kelkhoff}, year = {2024}, note = {R package version 0.2.4, https://github.com/Genentech/checked}, url = {https://Genentech.github.io/checked/}, }"},{"path":"https://Genentech.github.io/checked/index.html","id":"checked","dir":"","previous_headings":"","what":"Systematically Run R CMD Checks","title":"Systematically Run R CMD Checks","text":"Batch R CMD check management","code":""},{"path":"https://Genentech.github.io/checked/index.html","id":"running-checks","dir":"","previous_headings":"","what":"Running Checks","title":"Systematically Run R CMD Checks","text":"Although checked broadly capable running arbitrary sets R CMD check tasks, reverse dependency checking one common use cases batch R CMD checks needed. Running reverse dependency checks easy ","code":"library(checked) x <- run(\"/home/dev/praise\") results(x) #> # Revdep Check Task Spec #> #> goodpractice package R CMD check diff #> notes: OK #> warnings: OK #> errors: OK #> #> testthat package R CMD check diff #> notes: OK #> warnings: OK #> errors: OK"},{"path":"https://Genentech.github.io/checked/index.html","id":"monitoring-runs","dir":"","previous_headings":"","what":"Monitoring Runs","title":"Systematically Run R CMD Checks","text":"running many checks parallel can difficult process monitor, capable interfaces provide convenient output tracking various runs, check results package installations; keeping log issues might arise process. editor doesn’t support full output, might consider launching checks terminal less constrained. also free preferred editor use checks run.","code":"library(checked) run(\"/home/dev/praise\")"},{"path":"https://Genentech.github.io/checked/reference/DB_COLNAMES.html","id":null,"dir":"Reference","previous_headings":"","what":"Available packages database dependencies columns — DB_COLNAMES","title":"Available packages database dependencies columns — DB_COLNAMES","text":"Available packages database dependencies columns","code":""},{"path":"https://Genentech.github.io/checked/reference/DB_COLNAMES.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Available packages database dependencies columns — DB_COLNAMES","text":"","code":"DB_COLNAMES"},{"path":"https://Genentech.github.io/checked/reference/DB_COLNAMES.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Available packages database dependencies columns — DB_COLNAMES","text":"object class character length 6.","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP.html","id":null,"dir":"Reference","previous_headings":"","what":"Dependencies categories — DEP","title":"Dependencies categories — DEP","text":"Dependencies categories","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dependencies categories — DEP","text":"","code":"DEP"},{"path":"https://Genentech.github.io/checked/reference/DEP.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Dependencies categories — DEP","text":"object class list length 5.","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP_STRONG.html","id":null,"dir":"Reference","previous_headings":"","what":"Strong dependencies categories — DEP_STRONG","title":"Strong dependencies categories — DEP_STRONG","text":"Strong dependencies categories","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP_STRONG.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Strong dependencies categories — DEP_STRONG","text":"","code":"DEP_STRONG"},{"path":"https://Genentech.github.io/checked/reference/DEP_STRONG.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Strong dependencies categories — DEP_STRONG","text":"object class factor length 3.","code":""},{"path":"https://Genentech.github.io/checked/reference/STATUS.html","id":null,"dir":"Reference","previous_headings":"","what":"Check execution status categories — STATUS","title":"Check execution status categories — STATUS","text":"Check execution status categories","code":""},{"path":"https://Genentech.github.io/checked/reference/STATUS.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check execution status categories — STATUS","text":"","code":"STATUS"},{"path":"https://Genentech.github.io/checked/reference/STATUS.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Check execution status categories — STATUS","text":"object class list length 3.","code":""},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":null,"dir":"Reference","previous_headings":"","what":"Various utilities for formatting ANSI output — ansi","title":"Various utilities for formatting ANSI output — ansi","text":"Various utilities formatting ANSI output","code":""},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Various utilities for formatting ANSI output — ansi","text":"","code":"ansi_line_erase(n = \"\") ansi_move_line_rel(n)"},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Various utilities for formatting ANSI output — ansi","text":"n number lines move. Positive , negative .","code":""},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":"functions","dir":"Reference","previous_headings":"","what":"Functions","title":"Various utilities for formatting ANSI output — ansi","text":"ansi_line_erase(): Erase current line ansi_move_line_rel(): Offset cursor relative number lines","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":null,"dir":"Reference","previous_headings":"","what":"R6 Checks Coordinator — check_design","title":"R6 Checks Coordinator — check_design","text":"stateful object orchestrates separate processes required manage installation, library setup run R CMD checks sequence.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"R6 Checks Coordinator — check_design","text":"graph (igraph::igraph()) dependency graph, storing information dependencies required prior execution check task. Created task_graph_create() input (data.frame()) Checks task data.frame source checks. output (character(1)) Output directory raw results temporary library created stored.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"R6 Checks Coordinator — check_design","text":"check_design$new() check_design$active_processes() check_design$failed_tasks() check_design$terminate() check_design$step() check_design$start_next_task() check_design$is_done() check_design$clone()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"R6 Checks Coordinator — check_design","text":"Initialize new check design Use checks data.frame generate task graph dependencies installation order embedded.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$new( df, n = 2L, output = tempfile(paste(packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"R6 Checks Coordinator — check_design","text":"df check_design data.frame. n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical value, whether output directory unlinked running checks. FALSE, attempt made restore previous progress output. ... Additional arguments unused","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"R6 Checks Coordinator — check_design","text":"check_design.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-active-processes-","dir":"Reference","previous_headings":"","what":"Method active_processes()","title":"R6 Checks Coordinator — check_design","text":"Get Active Processes list","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$active_processes()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-failed-tasks-","dir":"Reference","previous_headings":"","what":"Method failed_tasks()","title":"R6 Checks Coordinator — check_design","text":"Get Failed Tasks list","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$failed_tasks()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-terminate-","dir":"Reference","previous_headings":"","what":"Method terminate()","title":"R6 Checks Coordinator — check_design","text":"Kill Active Design Processes Immediately terminates active processes.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$terminate()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-step-","dir":"Reference","previous_headings":"","what":"Method step()","title":"R6 Checks Coordinator — check_design","text":"Fill Available Processes Tasks","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$step()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"R6 Checks Coordinator — check_design","text":"logical value, indicating whether processes actively running.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-start-next-task-","dir":"Reference","previous_headings":"","what":"Method start_next_task()","title":"R6 Checks Coordinator — check_design","text":"Start Next Task","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$start_next_task()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"R6 Checks Coordinator — check_design","text":"integer value, coercible logical indicate whether new process spawned, -1 tasks finished.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-is-done-","dir":"Reference","previous_headings":"","what":"Method is_done()","title":"R6 Checks Coordinator — check_design","text":"Check checks done Checks whether scheduled tasks successfully executed.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$is_done()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"R6 Checks Coordinator — check_design","text":"objects class cloneable method.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$clone(deep = FALSE)"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"R6 Checks Coordinator — check_design","text":"deep Whether make deep clone.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"R6 Checks Coordinator — check_design","text":"","code":"if (FALSE) { # \\dontrun{ library(checked) df <- source_check_tasks_df(c( system.file(\"example_packages\", \"exampleBad\", package = \"checked\"), system.file(\"example_packages\", \"exampleGood\", package = \"checked\") )) plan <- check_design$new(df, n = 10, repos = \"https://cran.r-project.org/\") while (!plan$is_done()) { plan$start_next_task() } } # }"},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Run reverse dependency checks against a development version only — check_dev_rev_deps","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"check_dev_rev_deps() works similarly check_rev_deps() runs R CMD check package, development version package installed. advantageous check whether adding new package repository breaks existing packages possibly take said package Suggests dependency.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"","code":"check_dev_rev_deps( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":null,"dir":"Reference","previous_headings":"","what":"Check all package source directories in current directory — check_dir","title":"Check all package source directories in current directory — check_dir","text":"check_dir() Identifies R packages given directory (non-recursively) passes check_pkgs()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check all package source directories in current directory — check_dir","text":"","code":"check_dir( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check all package source directories in current directory — check_dir","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check all package source directories in current directory — check_dir","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_functions.html","id":null,"dir":"Reference","previous_headings":"","what":"Check functions — check_functions","title":"Check functions — check_functions","text":"Set functions run orchestrated R CMD checks automatically manage dependencies installation. functions prepares plan based supplied package source(s) includes installing dependencies running required R CMD checks. functions parallelized sperate processes","code":""},{"path":"https://Genentech.github.io/checked/reference/check_functions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check functions — check_functions","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. reverse_repos character vector repositories used pull sources reverse dependencies. cases, instance using binaries Linux, want use different repositories pulling sources check different installing dependencies. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_functions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check functions — check_functions","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":null,"dir":"Reference","previous_headings":"","what":"Check one or more package source directories — check_pkgs","title":"Check one or more package source directories — check_pkgs","text":"check_pkgs() Installs dependencies runs R CMD checks parallel source packages whose source code found path directory","code":""},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check one or more package source directories — check_pkgs","text":"","code":"check_pkgs( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check one or more package source directories — check_pkgs","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check one or more package source directories — check_pkgs","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Check reverse dependencies — check_rev_deps","title":"Check reverse dependencies — check_rev_deps","text":"Check package's reverse dependencies order identify differences reverse dependency check results run alongside package's development release versions.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check reverse dependencies — check_rev_deps","text":"","code":"check_rev_deps( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), reverse_repos = repos, restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check reverse dependencies — check_rev_deps","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. reverse_repos character vector repositories used pull sources reverse dependencies. cases, instance using binaries Linux, want use different repositories pulling sources check different installing dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check reverse dependencies — check_rev_deps","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check reverse dependencies — check_rev_deps","text":"Runs classical reverse dependency checks given source package. first identifies reverse dependencies available repos. , installing required dependencies, runs R CMD check twice package, one time release version given source package installed repos second time development version installed local source. R CMD checks later compared identify changes reverse dependency behaviors.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a task to run R CMD check — check_task_spec","title":"Create a task to run R CMD check — check_task_spec","text":"Create task run R CMD check","code":""},{"path":"https://Genentech.github.io/checked/reference/check_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a task to run R CMD check — check_task_spec","text":"","code":"check_task_spec( args = options::opt(\"check_args\"), build_args = options::opt(\"check_build_args\"), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a task to run R CMD check — check_task_spec","text":"args Character vector arguments pass R CMD check. Pass argument single element character vector (use spaces delimit arguments like shell). example, skip running examples tests, use args = c(\"---examples\", \"---tests\") args = \"---examples ---tests\". (Note instead --output option use check_dir argument, --output deal spaces special characters Windows.) build_args Character vector arguments pass R CMD build. Pass argument single element character vector (use spaces delimit arguments like shell). example, build_args = c(\"--force\", \"--keep-empty-dirs\") correct usage build_args = \"--force --keep-empty-dirs\" incorrect. ... Arguments passed task_spec alias task alias also serves unique identifier task. package_spec package_spec object env environmental variables set separate process running specific task.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":null,"dir":"Reference","previous_headings":"","what":"Check schedule data frame — checked-task-df","title":"Check schedule data frame — checked-task-df","text":"Create data.frame row defines package R CMD check run. data.frame prerequisite generating check_design() orchestrates processes including dependencies installation.","code":""},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check schedule data frame — checked-task-df","text":"path path package source. Can either single source code directory directory containing multiple package source code directories. ... parameters passed task specs allowing customize subprocesses.","code":""},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check schedule data frame — checked-task-df","text":"check schedule data.frame following columns: alias: alias check run. also serves purpose providing unique identifier node name task graph. version: Version package checked. package: Object inherits check_task_spec(). Defines package checked can acquired. custom: Object inherits custom_install_task_spec(). Defines custom package, instance available local source, installed checking package.","code":""},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check schedule data frame — checked-task-df","text":"_tasks_df() functions generate check task data.frame source packages specified path. Therefore accepts vector arbitrary length.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse R CMD checks from a partial check output string — checks_capture","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"Parse R CMD checks partial check output string","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"","code":"checks_capture(x)"},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"x string, compsoed subsection R CMD check console output","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"matrix matches capture groups \"check\" \"status\" (\"OK\", \"NONE\", \"NOTE\", \"WARNING\" \"ERROR\").","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"","code":"if (FALSE) { # \\dontrun{ check_output <- \" * checking check one ... OK * checking check two ... NOTE * checking tests ... Running test_abc.R Running test_xyz.R NONE * checking check three ... WARNING * ch \" checks_capture(check_output) } # }"},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":null,"dir":"Reference","previous_headings":"","what":"Simplify Captures into Vector — checks_simplify","title":"Simplify Captures into Vector — checks_simplify","text":"Simplify Captures Vector","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simplify Captures into Vector — checks_simplify","text":"","code":"checks_simplify(x)"},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simplify Captures into Vector — checks_simplify","text":"x Matrix regex captures produced checks_capture.","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simplify Captures into Vector — checks_simplify","text":"vector check status, names indicating check","code":""},{"path":"https://Genentech.github.io/checked/reference/cli.html","id":null,"dir":"Reference","previous_headings":"","what":"Internal Utilities for Command-line Output — cli","title":"Internal Utilities for Command-line Output — cli","text":"Various helper functions consistent cli output, including theming formatting.","code":""},{"path":"https://Genentech.github.io/checked/reference/cli.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Internal Utilities for Command-line Output — cli","text":"","code":"cli_table_row( status, ok = \"OK\", notes = \"N\", warnings = \"W\", errors = \"E\", msg = \"\", title = FALSE ) cli_theme(..., .envir = parent.frame())"},{"path":"https://Genentech.github.io/checked/reference/cli.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Internal Utilities for Command-line Output — cli","text":"status, ok, notes, warnings, errors character[1L] value include respective columns table. coerced character another type provided. msg character[1L] message include right table row entry. ..., .envir Additional arguments passed cli::cli_div()","code":""},{"path":"https://Genentech.github.io/checked/reference/custom_install_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a custom install task — custom_install_task_spec","title":"Create a custom install task — custom_install_task_spec","text":"Create custom install task","code":""},{"path":"https://Genentech.github.io/checked/reference/custom_install_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a custom install task — custom_install_task_spec","text":"","code":"custom_install_task_spec(...)"},{"path":"https://Genentech.github.io/checked/reference/custom_install_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a custom install task — custom_install_task_spec","text":"... Arguments passed install_task_spec type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . INSTALL_opts optional character vector additional option(s) passed R CMD INSTALL source package install. E.g., c(\"--html\", \"---multiarch\", \"---test-load\"). Can also named list character vectors used additional options, names respective package names.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/devnull.html","id":null,"dir":"Reference","previous_headings":"","what":"Reuse or Create A Null File Connection — devnull","title":"Reuse or Create A Null File Connection — devnull","text":"Reuse Create Null File Connection","code":""},{"path":"https://Genentech.github.io/checked/reference/devnull.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reuse or Create A Null File Connection — devnull","text":"","code":"devnull()"},{"path":"https://Genentech.github.io/checked/reference/install_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a task to install a package and dependencies — install_task_spec","title":"Create a task to install a package and dependencies — install_task_spec","text":"Create task install package dependencies","code":""},{"path":"https://Genentech.github.io/checked/reference/install_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a task to install a package and dependencies — install_task_spec","text":"","code":"install_task_spec(type = getOption(\"pkgType\"), INSTALL_opts = NULL, ...)"},{"path":"https://Genentech.github.io/checked/reference/install_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a task to install a package and dependencies — install_task_spec","text":"type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . INSTALL_opts optional character vector additional option(s) passed R CMD INSTALL source package install. E.g., c(\"--html\", \"---multiarch\", \"---test-load\"). Can also named list character vectors used additional options, names respective package names. ... Additional parameters passed task_spec()","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/new_check_design.html","id":null,"dir":"Reference","previous_headings":"","what":"Creating new Check Design Objects — new_check_design","title":"Creating new Check Design Objects — new_check_design","text":"Instantiate check design path directory.","code":""},{"path":"https://Genentech.github.io/checked/reference/new_check_design.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creating new Check Design Objects — new_check_design","text":"","code":"new_check_design(...) new_rev_dep_check_design(x, ...)"},{"path":"https://Genentech.github.io/checked/reference/new_check_design.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creating new Check Design Objects — new_check_design","text":"... Additional arguments passed new_check_design() x file path, passed rev_dep_check_tasks_df()","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/options.html","id":null,"dir":"Reference","previous_headings":"","what":"checked Options — options","title":"checked Options — options","text":"Internally used, package-specific options. options prioritize R options() values, fall back environment variables undefined. neither option environment variable set, default value used.","code":""},{"path":"https://Genentech.github.io/checked/reference/options.html","id":"checking-option-values","dir":"Reference","previous_headings":"","what":"Checking Option Values","title":"checked Options — options","text":"Option values specific checked can accessed passing package name env.","code":"options::opts(env = \"checked\") options::opt(x, default, env = \"checked\")"},{"path":"https://Genentech.github.io/checked/reference/options.html","id":"options","dir":"Reference","previous_headings":"","what":"Options","title":"checked Options — options","text":"tty_tick_interval default: 0.1 option: checked.tty_tick_interval envvar: R_CHECKED_TTY_TICK_INTERVAL (evaluated possible, raw string otherwise) results_error_on default: \"never\" option: checked.results_error_on envvar: R_CHECKED_RESULTS_ERROR_ON (evaluated possible, raw string otherwise) results_keep default: \"\" option: checked.results_keep envvar: R_CHECKED_RESULTS_KEEP (evaluated possible, raw string otherwise) restore default: NA option: checked.restore envvar: R_CHECKED_RESTORE (evaluated possible, raw string otherwise) check_envvars default: c(`_R_CHECK_FORCE_SUGGESTS_` = FALSE, `_R_CHECK_RD_XREFS_` = FALSE, `_R_CHECK_SYSTEM_CLOCK_` = FALSE, `_R_CHECK_SUGGESTS_ONLY_` = TRUE) option: checked.check_envvars envvar: R_CHECKED_CHECK_ENVVARS (evaluated possible, raw string otherwise) check_build_args default: c(\"---build-vignettes\", \"---manual\") option: checked.check_build_args envvar: R_CHECKED_CHECK_BUILD_ARGS (space-separated R CMD build flags) check_args default: c(\"--timings\", \"--ignore-vignettes\", \"---manual\") option: checked.check_args envvar: R_CHECKED_CHECK_ARGS (space-separated R CMD check flags)","code":"0.1 \"never\" \"all\" NA c(`_R_CHECK_FORCE_SUGGESTS_` = FALSE, `_R_CHECK_RD_XREFS_` = FALSE, `_R_CHECK_SYSTEM_CLOCK_` = FALSE, `_R_CHECK_SUGGESTS_ONLY_` = TRUE) c(\"--no-build-vignettes\", \"--no-manual\") c(\"--timings\", \"--ignore-vignettes\", \"--no-manual\")"},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/options_params.html","id":null,"dir":"Reference","previous_headings":"","what":"Checked Options — options_params","title":"Checked Options — options_params","text":"Checked Options","code":""},{"path":"https://Genentech.github.io/checked/reference/options_params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Checked Options — options_params","text":"results_error_on character vector indicating whether R error thrown issues discovered generating results. \"never\" means errors thrown. \"issues\" errors emitted issues, whereas \"potential issues\" stands error issues potential issues. (Defaults \"never\", overwritable using option 'checked.results_error_on' environment variable 'R_CHECKED_RESULTS_ERROR_ON') check_args character vector args passed R CMD check. (Defaults c(\"--timings\", \"--ignore-vignettes\", \"---manual\"), overwritable using option 'checked.check_args' environment variable 'R_CHECKED_CHECK_ARGS') results_keep character vector indicating packages included results. \"\" means packages kept. \"issues\" packages issues identified, whereas \"potential_issues\" stands keeping packages \"issues\" \"potential_issues\". (Defaults \"\", overwritable using option 'checked.results_keep' environment variable 'R_CHECKED_RESULTS_KEEP') check_envvars named character vector environment variables use R CMD check. (Defaults c(R_CHECK_FORCE_SUGGESTS= FALSE,R_CHECK_RD_XREFS= FALSE, ; R_CHECK_SYSTEM_CLOCK= FALSE,R_CHECK_SUGGESTS_ONLY = TRUE), overwritable using option 'checked.check_envvars' environment variable 'R_CHECKED_CHECK_ENVVARS') tty_tick_interval tty refresh interval reporting results milliseconds (Defaults 0.1, overwritable using option 'checked.tty_tick_interval' environment variable 'R_CHECKED_TTY_TICK_INTERVAL') check_build_args character vector args passed R CMD build. (Defaults c(\"---build-vignettes\", \"---manual\"), overwritable using option 'checked.check_build_args' environment variable 'R_CHECKED_CHECK_BUILD_ARGS') restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE')","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/package_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Package specification — package_spec","title":"Package specification — package_spec","text":"Create package specification list consists details required identify acquire source package.","code":""},{"path":"https://Genentech.github.io/checked/reference/package_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Package specification — package_spec","text":"","code":"package_spec(name = NULL, repos = NULL) package_spec_source(path = NULL, ...) package_spec_archive_source(path = NULL, ...)"},{"path":"https://Genentech.github.io/checked/reference/package_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Package specification — package_spec","text":"name name package. repos repository package given name identified. path path source package (either bundled ). URLs acceptable. ... parameters passed downstream constructors","code":""},{"path":"https://Genentech.github.io/checked/reference/print.checked_results.html","id":null,"dir":"Reference","previous_headings":"","what":"Print checked results — print.checked_results","title":"Print checked results — print.checked_results","text":"Print checked results","code":""},{"path":"https://Genentech.github.io/checked/reference/print.checked_results.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print checked results — print.checked_results","text":"","code":"# S3 method for class 'checked_results' print(x, ...) # S3 method for class 'checked_results_check_task_spec' print(x, keep = options::opt(\"results_keep\"), ...) # S3 method for class 'checked_results_revdep_check_task_spec' print(x, ...)"},{"path":"https://Genentech.github.io/checked/reference/print.checked_results.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print checked results — print.checked_results","text":"x object printed. ... parameters. keep character vector indicating packages included results. \"\" means packages kept. \"issues\" packages issues identified, whereas \"potential_issues\" stands keeping packages \"issues\" \"potential_issues\". (Defaults \"\", overwritable using option 'checked.results_keep' environment variable 'R_CHECKED_RESULTS_KEEP')","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/reporters-internal.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter Internal Methods — reporters-internal","title":"Reporter Internal Methods — reporters-internal","text":"internal methods reporters take reporter, check design object calling environment.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters-internal.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter Internal Methods — reporters-internal","text":"","code":"report_sleep(reporter, design, sleep) # Default S3 method report_sleep(reporter, design, sleep = 1) report_initialize(reporter, design, envir = parent.frame()) report_status(reporter, design, envir = parent.frame()) report_finalize(reporter, design)"},{"path":"https://Genentech.github.io/checked/reference/reporters-internal.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter Internal Methods — reporters-internal","text":"reporter object produced using reporters. reporter thin wrapper around environment class name dispatch. reporter mutable captures necessary state needs tracked reporting. design check_design check design report evaluates. sleep numeric interval pause reporter steps. envir environment environment attach , leverage -exit hooks.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Design Runner Reporters — reporters","title":"Check Design Runner Reporters — reporters","text":"Reporters used configure output communicated running check_design. range glossy command-line tools intended displaying progress interactive R session, line-feed logs may better suited automated execution, continuous itegration.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Design Runner Reporters — reporters","text":"","code":"reporter_ansi_tty() reporter_basic_tty() reporter_default()"},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"reporter-default-","dir":"Reference","previous_headings":"","what":"reporter_default()","title":"Check Design Runner Reporters — reporters","text":"Automatically chooses appropriate reporter based calling context.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"reporter-ansi-tty-","dir":"Reference","previous_headings":"","what":"reporter_ansi_tty()","title":"Check Design Runner Reporters — reporters","text":"Highly dynamic output fully capable terminals. Requires multi-line dynamic output, may available editors present terminal web component.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"reporter-basic-tty-","dir":"Reference","previous_headings":"","what":"reporter_basic_tty()","title":"Check Design Runner Reporters — reporters","text":"line-feed reporter presenting output one line time, providing reporter minimal assumptions terminal capabilities.","code":""},{"path":"https://Genentech.github.io/checked/reference/results.html","id":null,"dir":"Reference","previous_headings":"","what":"Check results — results","title":"Check results — results","text":"Get R CMD check results","code":""},{"path":"https://Genentech.github.io/checked/reference/results.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check results — results","text":"","code":"results(x, ...) # S3 method for class 'check_design' results(x, error_on = options::opt(\"results_error_on\"), ...)"},{"path":"https://Genentech.github.io/checked/reference/results.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check results — results","text":"x check_design object. ... parameters. error_on character vector indicating whether R error thrown issues discovered generating results. \"never\" means errors thrown. \"issues\" errors emitted issues, whereas \"potential issues\" stands error issues potential issues. (Defaults \"never\", overwritable using option 'checked.results_error_on' environment variable 'R_CHECKED_RESULTS_ERROR_ON')","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/results_to_file.html","id":null,"dir":"Reference","previous_headings":"","what":"Results to file — results_to_file","title":"Results to file — results_to_file","text":"Write checked_results object text file. converting results text, print.checked_results method used.","code":""},{"path":"https://Genentech.github.io/checked/reference/results_to_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Results to file — results_to_file","text":"","code":"results_to_file(results, file, keep = \"all\", ...)"},{"path":"https://Genentech.github.io/checked/reference/results_to_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Results to file — results_to_file","text":"results results object. file connection character path. keep character vector indicating packages included results. \"\" means packages kept. \"issues\" packages issues identified, whereas \"potential_issues\" stands keeping packages \"issues\" \"potential_issues\". (Defaults \"\", overwritable using option 'checked.results_keep' environment variable 'R_CHECKED_RESULTS_KEEP') ... parameters.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":null,"dir":"Reference","previous_headings":"","what":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"Create data.frame row defines package R CMD check run. data.frame prerequisite generating check_design() orchestrates processes including dependencies installation.","code":""},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"","code":"rev_dep_check_tasks_df( path, repos = getOption(\"repos\"), versions = c(\"dev\", \"release\"), ... )"},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"path path package source. Can either single source code directory directory containing multiple package source code directories. repos repository used identify reverse dependencies. versions character vector indicating versions package reverse dependency checked. c(\"dev\", \"release\") (default) stands classical reverse dependency check. \"dev\" checks development version package applicable mostly checking whether adding new package break tests packages already repository take package suggests dependency. ... parameters passed task specs allowing customize subprocesses.","code":""},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"check schedule data.frame following columns: alias: alias check run. also serves purpose providing unique identifier node name task graph. version: Version package checked. package: Object inherits check_task_spec(). Defines package checked can acquired. custom: Object inherits custom_install_task_spec(). Defines custom package, instance available local source, installed checking package.","code":""},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"_tasks_df() functions generate check task data.frame source packages specified path. Therefore accepts vector arbitrary length.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/revdep_check_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a task to run reverse dependency checks — revdep_check_task_spec","title":"Create a task to run reverse dependency checks — revdep_check_task_spec","text":"Create task run reverse dependency checks","code":""},{"path":"https://Genentech.github.io/checked/reference/revdep_check_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a task to run reverse dependency checks — revdep_check_task_spec","text":"","code":"revdep_check_task_spec(revdep, ...)"},{"path":"https://Genentech.github.io/checked/reference/revdep_check_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a task to run reverse dependency checks — revdep_check_task_spec","text":"revdep character indicating whether task specification describes check associated development (new) release (old) version reverse dependency check run. ... Additional parameters passed task_spec()","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/run.html","id":null,"dir":"Reference","previous_headings":"","what":"Run a Series of R CMD checks — run","title":"Run a Series of R CMD checks — run","text":"run() provides generic, central interface executing check_designs. path provided, new reverse dependency check plan generated source code path. Otherwise plan can built separately executed using run().","code":""},{"path":"https://Genentech.github.io/checked/reference/run.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run a Series of R CMD checks — run","text":"","code":"run(design, ..., reporter = reporter_default())"},{"path":"https://Genentech.github.io/checked/reference/run.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run a Series of R CMD checks — run","text":"design character check_design character value provided, first coerced check_design using new_rev_dep_check_design(). ... Additional arguments passed new_rev_dep_check_design() reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities.","code":""},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"'cli' implicitly push spinner output various output streams, affecting terminal cursor position. allow terminal interface spinners last line, function suppresses output simply returns frame contents.","code":""},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"","code":"silent_spinner(..., stream = devnull())"},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"... passed cli::make_spinner stream passed cli::make_spinner, defaults null file device","code":""},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"interface similar 'cli' spinner, suppressed output","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Task to Check a Package from Source — source_check_tasks_df","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"Create data.frame row defines package R CMD check run. data.frame prerequisite generating check_design() orchestrates processes including dependencies installation.","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"","code":"source_check_tasks_df(path, ...)"},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"path path package source. Can either single source code directory directory containing multiple package source code directories. ... parameters passed task specs allowing customize subprocesses.","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"check schedule data.frame following columns: alias: alias check run. also serves purpose providing unique identifier node name task graph. version: Version package checked. package: Object inherits check_task_spec(). Defines package checked can acquired. custom: Object inherits custom_install_task_spec(). Defines custom package, instance available local source, installed checking package.","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"_tasks_df() functions generate check task data.frame source packages specified path. Therefore accepts vector arbitrary length.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Task Graph — task_graph_create","title":"Create Task Graph — task_graph_create","text":"Create Task Graph","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Task Graph — task_graph_create","text":"","code":"task_graph_create(df, repos = getOption(\"repos\"))"},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Task Graph — task_graph_create","text":"df data.frame listing repos repositories used identify dependencies chain run R CMD checks","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Task Graph — task_graph_create","text":"dependency graph vertex attributes \"root\" (logical value indicating whether package one roots used create graph), \"status\" (installation status) \"order\" (installation order).","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_neighborhoods.html","id":null,"dir":"Reference","previous_headings":"","what":"Find Task Neighborhood — task_graph_neighborhoods","title":"Find Task Neighborhood — task_graph_neighborhoods","text":"Find Task Neighborhood","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_neighborhoods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find Task Neighborhood — task_graph_neighborhoods","text":"","code":"task_graph_neighborhoods(g, nodes)"},{"path":"https://Genentech.github.io/checked/reference/task_graph_neighborhoods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find Task Neighborhood — task_graph_neighborhoods","text":"g task graph, produced task_graph_create() nodes Names nodes objects packages whose neighborhoods calculated.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":null,"dir":"Reference","previous_headings":"","what":"Sort Task Graph by Strong Dependency Order — task_graph_sort","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"Sort Task Graph Strong Dependency Order","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"","code":"task_graph_sort(g)"},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"g igraph::graph, expected contain node attribute type.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"igraph::graph g, vertices sorted preferred installation order.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"Cyclic dependencies possible. Cyclic dependencies disallowed hard dependencies CRAN today, though historical instances appeared CRAN. Installation priority based : Total dependency footprint (low high) Topology (leaf nodes first)","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":null,"dir":"Reference","previous_headings":"","what":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"packages progress, ensure next selected package already dependencies done.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"","code":"task_graph_which_satisfied( g, v = igraph::V(g), dependencies = TRUE, status = STATUS$pending )"},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"g dependency graph, produced task_graph_create(). v Names nodes objects packages whose satisfiability checked. dependencies dependencies types met node considered satisfied. status status name. Nodes v fill filtered consists nodes status.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"name next package prioritize","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"helpers defined particular use cases strictly rely task_graph_which_satisfied(), : task_graph_which_satisfied_strong() - List vertices whose strong dependencies satisfied. task_graph_which_check_satisfied() - List root vertices whose dependencies satisfied. task_graph_which_install_satisfied() - List install vertices whose dependencies satisfied","code":""},{"path":"https://Genentech.github.io/checked/reference/task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Task specification — task_spec","title":"Task specification — task_spec","text":"Create task specification list consists details required run specific task.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Task specification — task_spec","text":"","code":"task_spec( alias = NULL, package_spec = NULL, env = options::opt(\"check_envvars\") )"},{"path":"https://Genentech.github.io/checked/reference/task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task specification — task_spec","text":"alias task alias also serves unique identifier task. package_spec package_spec object env environmental variables set separate process running specific task.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate A Rate Limiting Throttle Function — throttle","title":"Generate A Rate Limiting Throttle Function — throttle","text":"Generate Rate Limiting Throttle Function","code":""},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate A Rate Limiting Throttle Function — throttle","text":"","code":"throttle(interval = 0.2)"},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate A Rate Limiting Throttle Function — throttle","text":"interval interval (seconds) minimum interval throttle return TRUE.","code":""},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate A Rate Limiting Throttle Function — throttle","text":"throttling function provided interval. called, returns logical value indicating whether throttle interval passed (TRUE interval yet passed).","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-024","dir":"Changelog","previous_headings":"","what":"checked 0.2.4","title":"checked 0.2.4","text":"CRAN release: 2024-10-25 Fix check processes hanging forever system configurations. Remove whitespaces (\"[[:space:]]\") comparing potential issues skip false positives. Shortened many user-facing function names. general, uses reverse shortened rev, dependencies shortened deps, development shortened dev package shortened pkg. example, check_reverse_dependencies_development() shortened check_dev_rev_deps() (@dgkf-roche) Fix names enum function R lower 4.3. Add tests reverse dependency check use case. Make install_packages_process capture session’s available_packages_filters reuse installing packages ensure consistency main session filtering. Prettify output stripping excessive new lines. checked now depends options Expose ... allowing customization check subprocesses creating checks df. Force garbage collection scheduling task, make sure already finished processes removed memory.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-023","dir":"Changelog","previous_headings":"","what":"checked 0.2.3","title":"checked 0.2.3","text":"Use custom checked finisher’s instead processx finalizer’s cleaning finished processes avoid executing callbacks objects garbage collected. rev_dep_check_tasks_df add custom package value check associated release version package make sure, current release version package always fetched installed. Prevent results attempting read results unfinished checks.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-022","dir":"Changelog","previous_headings":"","what":"checked 0.2.2","title":"checked 0.2.2","text":"Clear unused utils functions (can_symlink, symlink_or_copy). Make sure output directory always created.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-021","dir":"Changelog","previous_headings":"","what":"checked 0.2.1","title":"checked 0.2.1","text":"Add results_to_file function.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-020","dir":"Changelog","previous_headings":"","what":"checked 0.2.0","title":"checked 0.2.0","text":"CRAN release: 2024-07-26 Change default private lib.loc value check_process R6 class NULL avoid staged installation failures. Terminate subprocesses run function interrupted comply CRAN requirements. Reorganize methods check_design making private. Remove warning possible problems isolation. Rename development_only parameter versions rev_dep_check_tasks_df Make sure check_reverse_dependencies works package available remote sources reverse dependencies. Add keep parameters print.checked_results_check_task_spec. Add error_on parameters results.check_design. Add $get_r_exit_status() method check install processes. Add warnings reporter whenever sub-processes non-zero exit status. Fix race condition reporting progress check processes.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-010","dir":"Changelog","previous_headings":"","what":"checked 0.1.0","title":"checked 0.1.0","text":"CRAN release: 2024-07-10 Package released CRAN","code":""}] +[{"path":"https://Genentech.github.io/checked/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 checked authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://Genentech.github.io/checked/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Szymon Maksymiuk. Maintainer, author. Doug Kelkhoff. Author. F. Hoffmann-La Roche AG. Copyright holder, funder.","code":""},{"path":"https://Genentech.github.io/checked/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Maksymiuk S, Kelkhoff D (2024). checked: Systematically Run R CMD Checks. R package version 0.2.5, https://github.com/Genentech/checked, https://Genentech.github.io/checked/.","code":"@Manual{, title = {checked: Systematically Run R CMD Checks}, author = {Szymon Maksymiuk and Doug Kelkhoff}, year = {2024}, note = {R package version 0.2.5, https://github.com/Genentech/checked}, url = {https://Genentech.github.io/checked/}, }"},{"path":"https://Genentech.github.io/checked/index.html","id":"checked","dir":"","previous_headings":"","what":"Systematically Run R CMD Checks","title":"Systematically Run R CMD Checks","text":"Batch R CMD check management","code":""},{"path":"https://Genentech.github.io/checked/index.html","id":"running-checks","dir":"","previous_headings":"","what":"Running Checks","title":"Systematically Run R CMD Checks","text":"Although checked broadly capable running arbitrary sets R CMD check tasks, reverse dependency checking one common use cases batch R CMD checks needed. Running reverse dependency checks easy ","code":"library(checked) x <- run(\"/home/dev/praise\") results(x) #> # Revdep Check Task Spec #> #> goodpractice package R CMD check diff #> notes: OK #> warnings: OK #> errors: OK #> #> testthat package R CMD check diff #> notes: OK #> warnings: OK #> errors: OK"},{"path":"https://Genentech.github.io/checked/index.html","id":"monitoring-runs","dir":"","previous_headings":"","what":"Monitoring Runs","title":"Systematically Run R CMD Checks","text":"running many checks parallel can difficult process monitor, capable interfaces provide convenient output tracking various runs, check results package installations; keeping log issues might arise process. editor doesn’t support full output, might consider launching checks terminal less constrained. also free preferred editor use checks run.","code":"library(checked) run(\"/home/dev/praise\")"},{"path":"https://Genentech.github.io/checked/reference/DB_COLNAMES.html","id":null,"dir":"Reference","previous_headings":"","what":"Available packages database dependencies columns — DB_COLNAMES","title":"Available packages database dependencies columns — DB_COLNAMES","text":"Available packages database dependencies columns","code":""},{"path":"https://Genentech.github.io/checked/reference/DB_COLNAMES.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Available packages database dependencies columns — DB_COLNAMES","text":"","code":"DB_COLNAMES"},{"path":"https://Genentech.github.io/checked/reference/DB_COLNAMES.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Available packages database dependencies columns — DB_COLNAMES","text":"object class character length 6.","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP.html","id":null,"dir":"Reference","previous_headings":"","what":"Dependencies categories — DEP","title":"Dependencies categories — DEP","text":"Dependencies categories","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dependencies categories — DEP","text":"","code":"DEP"},{"path":"https://Genentech.github.io/checked/reference/DEP.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Dependencies categories — DEP","text":"object class list length 5.","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP_STRONG.html","id":null,"dir":"Reference","previous_headings":"","what":"Strong dependencies categories — DEP_STRONG","title":"Strong dependencies categories — DEP_STRONG","text":"Strong dependencies categories","code":""},{"path":"https://Genentech.github.io/checked/reference/DEP_STRONG.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Strong dependencies categories — DEP_STRONG","text":"","code":"DEP_STRONG"},{"path":"https://Genentech.github.io/checked/reference/DEP_STRONG.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Strong dependencies categories — DEP_STRONG","text":"object class factor length 3.","code":""},{"path":"https://Genentech.github.io/checked/reference/STATUS.html","id":null,"dir":"Reference","previous_headings":"","what":"Check execution status categories — STATUS","title":"Check execution status categories — STATUS","text":"Check execution status categories","code":""},{"path":"https://Genentech.github.io/checked/reference/STATUS.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check execution status categories — STATUS","text":"","code":"STATUS"},{"path":"https://Genentech.github.io/checked/reference/STATUS.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Check execution status categories — STATUS","text":"object class list length 3.","code":""},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":null,"dir":"Reference","previous_headings":"","what":"Various utilities for formatting ANSI output — ansi","title":"Various utilities for formatting ANSI output — ansi","text":"Various utilities formatting ANSI output","code":""},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Various utilities for formatting ANSI output — ansi","text":"","code":"ansi_line_erase(n = \"\") ansi_move_line_rel(n)"},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Various utilities for formatting ANSI output — ansi","text":"n number lines move. Positive , negative .","code":""},{"path":"https://Genentech.github.io/checked/reference/ansi.html","id":"functions","dir":"Reference","previous_headings":"","what":"Functions","title":"Various utilities for formatting ANSI output — ansi","text":"ansi_line_erase(): Erase current line ansi_move_line_rel(): Offset cursor relative number lines","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":null,"dir":"Reference","previous_headings":"","what":"R6 Checks Coordinator — check_design","title":"R6 Checks Coordinator — check_design","text":"stateful object orchestrates separate processes required manage installation, library setup run R CMD checks sequence.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"R6 Checks Coordinator — check_design","text":"graph (igraph::igraph()) dependency graph, storing information dependencies required prior execution check task. Created task_graph_create() input (data.frame()) Checks task data.frame source checks. output (character(1)) Output directory raw results temporary library created stored.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"R6 Checks Coordinator — check_design","text":"check_design$new() check_design$active_processes() check_design$failed_tasks() check_design$terminate() check_design$step() check_design$start_next_task() check_design$is_done() check_design$clone()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"R6 Checks Coordinator — check_design","text":"Initialize new check design Use checks data.frame generate task graph dependencies installation order embedded.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$new( df, n = 2L, output = tempfile(paste(packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"R6 Checks Coordinator — check_design","text":"df check_design data.frame. n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical value, whether output directory unlinked running checks. FALSE, attempt made restore previous progress output. ... Additional arguments unused","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"R6 Checks Coordinator — check_design","text":"check_design.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-active-processes-","dir":"Reference","previous_headings":"","what":"Method active_processes()","title":"R6 Checks Coordinator — check_design","text":"Get Active Processes list","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$active_processes()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-failed-tasks-","dir":"Reference","previous_headings":"","what":"Method failed_tasks()","title":"R6 Checks Coordinator — check_design","text":"Get Failed Tasks list","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$failed_tasks()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-terminate-","dir":"Reference","previous_headings":"","what":"Method terminate()","title":"R6 Checks Coordinator — check_design","text":"Kill Active Design Processes Immediately terminates active processes.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$terminate()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-step-","dir":"Reference","previous_headings":"","what":"Method step()","title":"R6 Checks Coordinator — check_design","text":"Fill Available Processes Tasks","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$step()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"R6 Checks Coordinator — check_design","text":"logical value, indicating whether processes actively running.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-start-next-task-","dir":"Reference","previous_headings":"","what":"Method start_next_task()","title":"R6 Checks Coordinator — check_design","text":"Start Next Task","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$start_next_task()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"R6 Checks Coordinator — check_design","text":"integer value, coercible logical indicate whether new process spawned, -1 tasks finished.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-is-done-","dir":"Reference","previous_headings":"","what":"Method is_done()","title":"R6 Checks Coordinator — check_design","text":"Check checks done Checks whether scheduled tasks successfully executed.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$is_done()"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"R6 Checks Coordinator — check_design","text":"objects class cloneable method.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"R6 Checks Coordinator — check_design","text":"","code":"check_design$clone(deep = FALSE)"},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"R6 Checks Coordinator — check_design","text":"deep Whether make deep clone.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_design.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"R6 Checks Coordinator — check_design","text":"","code":"if (FALSE) { # \\dontrun{ library(checked) df <- source_check_tasks_df(c( system.file(\"example_packages\", \"exampleBad\", package = \"checked\"), system.file(\"example_packages\", \"exampleGood\", package = \"checked\") )) plan <- check_design$new(df, n = 10, repos = \"https://cran.r-project.org/\") while (!plan$is_done()) { plan$start_next_task() } } # }"},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Run reverse dependency checks against a development version only — check_dev_rev_deps","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"check_dev_rev_deps() works similarly check_rev_deps() runs R CMD check package, development version package installed. advantageous check whether adding new package repository breaks existing packages possibly take said package Suggests dependency.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"","code":"check_dev_rev_deps( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dev_rev_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run reverse dependency checks against a development version only — check_dev_rev_deps","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":null,"dir":"Reference","previous_headings":"","what":"Check all package source directories in current directory — check_dir","title":"Check all package source directories in current directory — check_dir","text":"check_dir() Identifies R packages given directory (non-recursively) passes check_pkgs()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check all package source directories in current directory — check_dir","text":"","code":"check_dir( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check all package source directories in current directory — check_dir","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_dir.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check all package source directories in current directory — check_dir","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_functions.html","id":null,"dir":"Reference","previous_headings":"","what":"Check functions — check_functions","title":"Check functions — check_functions","text":"Set functions run orchestrated R CMD checks automatically manage dependencies installation. functions prepares plan based supplied package source(s) includes installing dependencies running required R CMD checks. functions parallelized sperate processes","code":""},{"path":"https://Genentech.github.io/checked/reference/check_functions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check functions — check_functions","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. reverse_repos character vector repositories used pull sources reverse dependencies. cases, instance using binaries Linux, want use different repositories pulling sources check different installing dependencies. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_functions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check functions — check_functions","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":null,"dir":"Reference","previous_headings":"","what":"Check one or more package source directories — check_pkgs","title":"Check one or more package source directories — check_pkgs","text":"check_pkgs() Installs dependencies runs R CMD checks parallel source packages whose source code found path directory","code":""},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check one or more package source directories — check_pkgs","text":"","code":"check_pkgs( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check one or more package source directories — check_pkgs","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_pkgs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check one or more package source directories — check_pkgs","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Check reverse dependencies — check_rev_deps","title":"Check reverse dependencies — check_rev_deps","text":"Check package's reverse dependencies order identify differences reverse dependency check results run alongside package's development release versions.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check reverse dependencies — check_rev_deps","text":"","code":"check_rev_deps( path, n = 2L, output = tempfile(paste(utils::packageName(), Sys.Date(), sep = \"-\")), lib.loc = .libPaths(), repos = getOption(\"repos\"), reverse_repos = repos, restore = options::opt(\"restore\"), reporter = reporter_default(), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check reverse dependencies — check_rev_deps","text":"path file path package source directory n integer value indicating maximum number subprocesses can simultaneously spawned executing tasks. output character value specifying path output stored. lib.loc character vector libraries allowed used checking packages, defaults entire .libPaths(). repos character vector repositories used generating task graph later pulling dependencies. reverse_repos character vector repositories used pull sources reverse dependencies. cases, instance using binaries Linux, want use different repositories pulling sources check different installing dependencies. restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE') reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities. ... Additional arguments passed checked-task-df run()","code":""},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check reverse dependencies — check_rev_deps","text":"check_design() R6 class storing details regarding checks run. Can combined results summary() methods generate results.","code":""},{"path":"https://Genentech.github.io/checked/reference/check_rev_deps.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check reverse dependencies — check_rev_deps","text":"Runs classical reverse dependency checks given source package. first identifies reverse dependencies available repos. , installing required dependencies, runs R CMD check twice package, one time release version given source package installed repos second time development version installed local source. R CMD checks later compared identify changes reverse dependency behaviors.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/check_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a task to run R CMD check — check_task_spec","title":"Create a task to run R CMD check — check_task_spec","text":"Create task run R CMD check","code":""},{"path":"https://Genentech.github.io/checked/reference/check_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a task to run R CMD check — check_task_spec","text":"","code":"check_task_spec( args = options::opt(\"check_args\"), build_args = options::opt(\"check_build_args\"), ... )"},{"path":"https://Genentech.github.io/checked/reference/check_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a task to run R CMD check — check_task_spec","text":"args Character vector arguments pass R CMD check. Pass argument single element character vector (use spaces delimit arguments like shell). example, skip running examples tests, use args = c(\"---examples\", \"---tests\") args = \"---examples ---tests\". (Note instead --output option use check_dir argument, --output deal spaces special characters Windows.) build_args Character vector arguments pass R CMD build. Pass argument single element character vector (use spaces delimit arguments like shell). example, build_args = c(\"--force\", \"--keep-empty-dirs\") correct usage build_args = \"--force --keep-empty-dirs\" incorrect. ... Arguments passed task_spec alias task alias also serves unique identifier task. package_spec package_spec object env environmental variables set separate process running specific task.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":null,"dir":"Reference","previous_headings":"","what":"Check schedule data frame — checked-task-df","title":"Check schedule data frame — checked-task-df","text":"Create data.frame row defines package R CMD check run. data.frame prerequisite generating check_design() orchestrates processes including dependencies installation.","code":""},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check schedule data frame — checked-task-df","text":"path path package source. Can either single source code directory directory containing multiple package source code directories. ... parameters passed task specs allowing customize subprocesses.","code":""},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check schedule data frame — checked-task-df","text":"check schedule data.frame following columns: alias: alias check run. also serves purpose providing unique identifier node name task graph. version: Version package checked. package: Object inherits check_task_spec(). Defines package checked can acquired. custom: Object inherits custom_install_task_spec(). Defines custom package, instance available local source, installed checking package.","code":""},{"path":"https://Genentech.github.io/checked/reference/checked-task-df.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check schedule data frame — checked-task-df","text":"_tasks_df() functions generate check task data.frame source packages specified path. Therefore accepts vector arbitrary length.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse R CMD checks from a partial check output string — checks_capture","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"Parse R CMD checks partial check output string","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"","code":"checks_capture(x)"},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"x string, compsoed subsection R CMD check console output","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"matrix matches capture groups \"check\" \"status\" (\"OK\", \"NONE\", \"NOTE\", \"WARNING\" \"ERROR\").","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_capture.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse R CMD checks from a partial check output string — checks_capture","text":"","code":"if (FALSE) { # \\dontrun{ check_output <- \" * checking check one ... OK * checking check two ... NOTE * checking tests ... Running test_abc.R Running test_xyz.R NONE * checking check three ... WARNING * ch \" checks_capture(check_output) } # }"},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":null,"dir":"Reference","previous_headings":"","what":"Simplify Captures into Vector — checks_simplify","title":"Simplify Captures into Vector — checks_simplify","text":"Simplify Captures Vector","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simplify Captures into Vector — checks_simplify","text":"","code":"checks_simplify(x)"},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simplify Captures into Vector — checks_simplify","text":"x Matrix regex captures produced checks_capture.","code":""},{"path":"https://Genentech.github.io/checked/reference/checks_simplify.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simplify Captures into Vector — checks_simplify","text":"vector check status, names indicating check","code":""},{"path":"https://Genentech.github.io/checked/reference/cli.html","id":null,"dir":"Reference","previous_headings":"","what":"Internal Utilities for Command-line Output — cli","title":"Internal Utilities for Command-line Output — cli","text":"Various helper functions consistent cli output, including theming formatting.","code":""},{"path":"https://Genentech.github.io/checked/reference/cli.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Internal Utilities for Command-line Output — cli","text":"","code":"cli_table_row( status, ok = \"OK\", notes = \"N\", warnings = \"W\", errors = \"E\", msg = \"\", title = FALSE ) cli_theme(..., .envir = parent.frame())"},{"path":"https://Genentech.github.io/checked/reference/cli.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Internal Utilities for Command-line Output — cli","text":"status, ok, notes, warnings, errors character[1L] value include respective columns table. coerced character another type provided. msg character[1L] message include right table row entry. ..., .envir Additional arguments passed cli::cli_div()","code":""},{"path":"https://Genentech.github.io/checked/reference/custom_install_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a custom install task — custom_install_task_spec","title":"Create a custom install task — custom_install_task_spec","text":"Create custom install task","code":""},{"path":"https://Genentech.github.io/checked/reference/custom_install_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a custom install task — custom_install_task_spec","text":"","code":"custom_install_task_spec(...)"},{"path":"https://Genentech.github.io/checked/reference/custom_install_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a custom install task — custom_install_task_spec","text":"... Arguments passed install_task_spec type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . INSTALL_opts optional character vector additional option(s) passed R CMD INSTALL source package install. E.g., c(\"--html\", \"---multiarch\", \"---test-load\"). Can also named list character vectors used additional options, names respective package names.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/devnull.html","id":null,"dir":"Reference","previous_headings":"","what":"Reuse or Create A Null File Connection — devnull","title":"Reuse or Create A Null File Connection — devnull","text":"Reuse Create Null File Connection","code":""},{"path":"https://Genentech.github.io/checked/reference/devnull.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reuse or Create A Null File Connection — devnull","text":"","code":"devnull()"},{"path":"https://Genentech.github.io/checked/reference/install_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a task to install a package and dependencies — install_task_spec","title":"Create a task to install a package and dependencies — install_task_spec","text":"Create task install package dependencies","code":""},{"path":"https://Genentech.github.io/checked/reference/install_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a task to install a package and dependencies — install_task_spec","text":"","code":"install_task_spec(type = getOption(\"pkgType\"), INSTALL_opts = NULL, ...)"},{"path":"https://Genentech.github.io/checked/reference/install_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a task to install a package and dependencies — install_task_spec","text":"type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . INSTALL_opts optional character vector additional option(s) passed R CMD INSTALL source package install. E.g., c(\"--html\", \"---multiarch\", \"---test-load\"). Can also named list character vectors used additional options, names respective package names. ... Additional parameters passed task_spec()","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/new_check_design.html","id":null,"dir":"Reference","previous_headings":"","what":"Creating new Check Design Objects — new_check_design","title":"Creating new Check Design Objects — new_check_design","text":"Instantiate check design path directory.","code":""},{"path":"https://Genentech.github.io/checked/reference/new_check_design.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creating new Check Design Objects — new_check_design","text":"","code":"new_check_design(...) new_rev_dep_check_design(x, ...)"},{"path":"https://Genentech.github.io/checked/reference/new_check_design.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creating new Check Design Objects — new_check_design","text":"... Additional arguments passed new_check_design() x file path, passed rev_dep_check_tasks_df()","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/options.html","id":null,"dir":"Reference","previous_headings":"","what":"checked Options — options","title":"checked Options — options","text":"Internally used, package-specific options. options prioritize R options() values, fall back environment variables undefined. neither option environment variable set, default value used.","code":""},{"path":"https://Genentech.github.io/checked/reference/options.html","id":"checking-option-values","dir":"Reference","previous_headings":"","what":"Checking Option Values","title":"checked Options — options","text":"Option values specific checked can accessed passing package name env.","code":"options::opts(env = \"checked\") options::opt(x, default, env = \"checked\")"},{"path":"https://Genentech.github.io/checked/reference/options.html","id":"options","dir":"Reference","previous_headings":"","what":"Options","title":"checked Options — options","text":"tty_tick_interval default: 0.1 option: checked.tty_tick_interval envvar: R_CHECKED_TTY_TICK_INTERVAL (evaluated possible, raw string otherwise) results_error_on default: \"never\" option: checked.results_error_on envvar: R_CHECKED_RESULTS_ERROR_ON (evaluated possible, raw string otherwise) results_keep default: \"\" option: checked.results_keep envvar: R_CHECKED_RESULTS_KEEP (evaluated possible, raw string otherwise) restore default: NA option: checked.restore envvar: R_CHECKED_RESTORE (evaluated possible, raw string otherwise) check_envvars default: c(`_R_CHECK_FORCE_SUGGESTS_` = FALSE, `_R_CHECK_RD_XREFS_` = FALSE, `_R_CHECK_SYSTEM_CLOCK_` = FALSE, `_R_CHECK_SUGGESTS_ONLY_` = TRUE) option: checked.check_envvars envvar: R_CHECKED_CHECK_ENVVARS (evaluated possible, raw string otherwise) check_build_args default: c(\"---build-vignettes\", \"---manual\") option: checked.check_build_args envvar: R_CHECKED_CHECK_BUILD_ARGS (space-separated R CMD build flags) check_args default: c(\"--timings\", \"--ignore-vignettes\", \"---manual\") option: checked.check_args envvar: R_CHECKED_CHECK_ARGS (space-separated R CMD check flags)","code":"0.1 \"never\" \"all\" NA c(`_R_CHECK_FORCE_SUGGESTS_` = FALSE, `_R_CHECK_RD_XREFS_` = FALSE, `_R_CHECK_SYSTEM_CLOCK_` = FALSE, `_R_CHECK_SUGGESTS_ONLY_` = TRUE) c(\"--no-build-vignettes\", \"--no-manual\") c(\"--timings\", \"--ignore-vignettes\", \"--no-manual\")"},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/options_params.html","id":null,"dir":"Reference","previous_headings":"","what":"Checked Options — options_params","title":"Checked Options — options_params","text":"Checked Options","code":""},{"path":"https://Genentech.github.io/checked/reference/options_params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Checked Options — options_params","text":"results_error_on character vector indicating whether R error thrown issues discovered generating results. \"never\" means errors thrown. \"issues\" errors emitted issues, whereas \"potential issues\" stands error issues potential issues. (Defaults \"never\", overwritable using option 'checked.results_error_on' environment variable 'R_CHECKED_RESULTS_ERROR_ON') check_args character vector args passed R CMD check. (Defaults c(\"--timings\", \"--ignore-vignettes\", \"---manual\"), overwritable using option 'checked.check_args' environment variable 'R_CHECKED_CHECK_ARGS') results_keep character vector indicating packages included results. \"\" means packages kept. \"issues\" packages issues identified, whereas \"potential_issues\" stands keeping packages \"issues\" \"potential_issues\". (Defaults \"\", overwritable using option 'checked.results_keep' environment variable 'R_CHECKED_RESULTS_KEEP') check_envvars named character vector environment variables use R CMD check. (Defaults c(R_CHECK_FORCE_SUGGESTS= FALSE,R_CHECK_RD_XREFS= FALSE, ; R_CHECK_SYSTEM_CLOCK= FALSE,R_CHECK_SUGGESTS_ONLY = TRUE), overwritable using option 'checked.check_envvars' environment variable 'R_CHECKED_CHECK_ENVVARS') tty_tick_interval tty refresh interval reporting results milliseconds (Defaults 0.1, overwritable using option 'checked.tty_tick_interval' environment variable 'R_CHECKED_TTY_TICK_INTERVAL') check_build_args character vector args passed R CMD build. (Defaults c(\"---build-vignettes\", \"---manual\"), overwritable using option 'checked.check_build_args' environment variable 'R_CHECKED_CHECK_BUILD_ARGS') restore logical indicating whether output directory unlinked running checks. FALSE, attempt made restore previous progress output (Defaults NA, overwritable using option 'checked.restore' environment variable 'R_CHECKED_RESTORE')","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/package_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Package specification — package_spec","title":"Package specification — package_spec","text":"Create package specification list consists details required identify acquire source package.","code":""},{"path":"https://Genentech.github.io/checked/reference/package_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Package specification — package_spec","text":"","code":"package_spec(name = NULL, repos = NULL) package_spec_source(path = NULL, ...) package_spec_archive_source(path = NULL, ...)"},{"path":"https://Genentech.github.io/checked/reference/package_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Package specification — package_spec","text":"name name package. repos repository package given name identified. path path source package (either bundled ). URLs acceptable. ... parameters passed downstream constructors","code":""},{"path":"https://Genentech.github.io/checked/reference/print.checked_results.html","id":null,"dir":"Reference","previous_headings":"","what":"Print checked results — print.checked_results","title":"Print checked results — print.checked_results","text":"Print checked results","code":""},{"path":"https://Genentech.github.io/checked/reference/print.checked_results.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print checked results — print.checked_results","text":"","code":"# S3 method for class 'checked_results' print(x, ...) # S3 method for class 'checked_results_check_task_spec' print(x, keep = options::opt(\"results_keep\"), ...) # S3 method for class 'checked_results_revdep_check_task_spec' print(x, ...)"},{"path":"https://Genentech.github.io/checked/reference/print.checked_results.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print checked results — print.checked_results","text":"x object printed. ... parameters. keep character vector indicating packages included results. \"\" means packages kept. \"issues\" packages issues identified, whereas \"potential_issues\" stands keeping packages \"issues\" \"potential_issues\". (Defaults \"\", overwritable using option 'checked.results_keep' environment variable 'R_CHECKED_RESULTS_KEEP')","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/reporters-internal.html","id":null,"dir":"Reference","previous_headings":"","what":"Reporter Internal Methods — reporters-internal","title":"Reporter Internal Methods — reporters-internal","text":"internal methods reporters take reporter, check design object calling environment.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters-internal.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reporter Internal Methods — reporters-internal","text":"","code":"report_sleep(reporter, design, sleep) # Default S3 method report_sleep(reporter, design, sleep = 1) report_initialize(reporter, design, envir = parent.frame()) report_status(reporter, design, envir = parent.frame()) report_finalize(reporter, design)"},{"path":"https://Genentech.github.io/checked/reference/reporters-internal.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reporter Internal Methods — reporters-internal","text":"reporter object produced using reporters. reporter thin wrapper around environment class name dispatch. reporter mutable captures necessary state needs tracked reporting. design check_design check design report evaluates. sleep numeric interval pause reporter steps. envir environment environment attach , leverage -exit hooks.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Design Runner Reporters — reporters","title":"Check Design Runner Reporters — reporters","text":"Reporters used configure output communicated running check_design. range glossy command-line tools intended displaying progress interactive R session, line-feed logs may better suited automated execution, continuous itegration.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Design Runner Reporters — reporters","text":"","code":"reporter_ansi_tty() reporter_basic_tty() reporter_default()"},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"reporter-default-","dir":"Reference","previous_headings":"","what":"reporter_default()","title":"Check Design Runner Reporters — reporters","text":"Automatically chooses appropriate reporter based calling context.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"reporter-ansi-tty-","dir":"Reference","previous_headings":"","what":"reporter_ansi_tty()","title":"Check Design Runner Reporters — reporters","text":"Highly dynamic output fully capable terminals. Requires multi-line dynamic output, may available editors present terminal web component.","code":""},{"path":"https://Genentech.github.io/checked/reference/reporters.html","id":"reporter-basic-tty-","dir":"Reference","previous_headings":"","what":"reporter_basic_tty()","title":"Check Design Runner Reporters — reporters","text":"line-feed reporter presenting output one line time, providing reporter minimal assumptions terminal capabilities.","code":""},{"path":"https://Genentech.github.io/checked/reference/results.html","id":null,"dir":"Reference","previous_headings":"","what":"Check results — results","title":"Check results — results","text":"Get R CMD check results","code":""},{"path":"https://Genentech.github.io/checked/reference/results.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check results — results","text":"","code":"results(x, ...) # S3 method for class 'check_design' results(x, error_on = options::opt(\"results_error_on\"), ...)"},{"path":"https://Genentech.github.io/checked/reference/results.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check results — results","text":"x check_design object. ... parameters. error_on character vector indicating whether R error thrown issues discovered generating results. \"never\" means errors thrown. \"issues\" errors emitted issues, whereas \"potential issues\" stands error issues potential issues. (Defaults \"never\", overwritable using option 'checked.results_error_on' environment variable 'R_CHECKED_RESULTS_ERROR_ON')","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/results_to_file.html","id":null,"dir":"Reference","previous_headings":"","what":"Results to file — results_to_file","title":"Results to file — results_to_file","text":"Write checked_results object text file. converting results text, print.checked_results method used.","code":""},{"path":"https://Genentech.github.io/checked/reference/results_to_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Results to file — results_to_file","text":"","code":"results_to_file(results, file, keep = \"all\", ...)"},{"path":"https://Genentech.github.io/checked/reference/results_to_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Results to file — results_to_file","text":"results results object. file connection character path. keep character vector indicating packages included results. \"\" means packages kept. \"issues\" packages issues identified, whereas \"potential_issues\" stands keeping packages \"issues\" \"potential_issues\". (Defaults \"\", overwritable using option 'checked.results_keep' environment variable 'R_CHECKED_RESULTS_KEEP') ... parameters.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":null,"dir":"Reference","previous_headings":"","what":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"Create data.frame row defines package R CMD check run. data.frame prerequisite generating check_design() orchestrates processes including dependencies installation.","code":""},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"","code":"rev_dep_check_tasks_df( path, repos = getOption(\"repos\"), versions = c(\"dev\", \"release\"), lib.loc = .libPaths(), ... )"},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"path path package source. Can either single source code directory directory containing multiple package source code directories. repos repository used identify reverse dependencies. versions character vector indicating versions package reverse dependency checked. c(\"dev\", \"release\") (default) stands classical reverse dependency check. \"dev\" checks development version package applicable mostly checking whether adding new package break tests packages already repository take package suggests dependency. lib.loc vector libraries used check whether reverse dependency check can return accurate results. ... parameters passed task specs allowing customize subprocesses.","code":""},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"check schedule data.frame following columns: alias: alias check run. also serves purpose providing unique identifier node name task graph. version: Version package checked. package: Object inherits check_task_spec(). Defines package checked can acquired. custom: Object inherits custom_install_task_spec(). Defines custom package, instance available local source, installed checking package.","code":""},{"path":"https://Genentech.github.io/checked/reference/rev_dep_check_tasks_df.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build Tasks for Reverse Dependency Checks Generates checks schedule data.frame appropriate for running reverse dependency check for certain source package. In such case path parameter should point to the source of the development version of the package and repos should be a repository for which reverse dependencies should be identified. — rev_dep_check_tasks_df","text":"_tasks_df() functions generate check task data.frame source packages specified path. Therefore accepts vector arbitrary length.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/revdep_check_task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a task to run reverse dependency checks — revdep_check_task_spec","title":"Create a task to run reverse dependency checks — revdep_check_task_spec","text":"Create task run reverse dependency checks","code":""},{"path":"https://Genentech.github.io/checked/reference/revdep_check_task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a task to run reverse dependency checks — revdep_check_task_spec","text":"","code":"revdep_check_task_spec(revdep, ...)"},{"path":"https://Genentech.github.io/checked/reference/revdep_check_task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a task to run reverse dependency checks — revdep_check_task_spec","text":"revdep character indicating whether task specification describes check associated development (new) release (old) version reverse dependency check run. ... Additional parameters passed task_spec()","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/run.html","id":null,"dir":"Reference","previous_headings":"","what":"Run a Series of R CMD checks — run","title":"Run a Series of R CMD checks — run","text":"run() provides generic, central interface executing check_designs. path provided, new reverse dependency check plan generated source code path. Otherwise plan can built separately executed using run().","code":""},{"path":"https://Genentech.github.io/checked/reference/run.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run a Series of R CMD checks — run","text":"","code":"run(design, ..., reporter = reporter_default())"},{"path":"https://Genentech.github.io/checked/reference/run.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run a Series of R CMD checks — run","text":"design character check_design character value provided, first coerced check_design using new_rev_dep_check_design(). ... Additional arguments passed new_rev_dep_check_design() reporter reporter provide progress updates. default expressive command-line reporter given terminal capabilities.","code":""},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"'cli' implicitly push spinner output various output streams, affecting terminal cursor position. allow terminal interface spinners last line, function suppresses output simply returns frame contents.","code":""},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"","code":"silent_spinner(..., stream = devnull())"},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"... passed cli::make_spinner stream passed cli::make_spinner, defaults null file device","code":""},{"path":"https://Genentech.github.io/checked/reference/silent_spinner.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a 'cli' Spinner With Suppressed Output — silent_spinner","text":"interface similar 'cli' spinner, suppressed output","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Task to Check a Package from Source — source_check_tasks_df","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"Create data.frame row defines package R CMD check run. data.frame prerequisite generating check_design() orchestrates processes including dependencies installation.","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"","code":"source_check_tasks_df(path, ...)"},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"path path package source. Can either single source code directory directory containing multiple package source code directories. ... parameters passed task specs allowing customize subprocesses.","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"check schedule data.frame following columns: alias: alias check run. also serves purpose providing unique identifier node name task graph. version: Version package checked. package: Object inherits check_task_spec(). Defines package checked can acquired. custom: Object inherits custom_install_task_spec(). Defines custom package, instance available local source, installed checking package.","code":""},{"path":"https://Genentech.github.io/checked/reference/source_check_tasks_df.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a Task to Check a Package from Source — source_check_tasks_df","text":"_tasks_df() functions generate check task data.frame source packages specified path. Therefore accepts vector arbitrary length.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Task Graph — task_graph_create","title":"Create Task Graph — task_graph_create","text":"Create Task Graph","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Task Graph — task_graph_create","text":"","code":"task_graph_create(df, repos = getOption(\"repos\"))"},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Task Graph — task_graph_create","text":"df data.frame listing repos repositories used identify dependencies chain run R CMD checks","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Task Graph — task_graph_create","text":"dependency graph vertex attributes \"root\" (logical value indicating whether package one roots used create graph), \"status\" (installation status) \"order\" (installation order).","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_neighborhoods.html","id":null,"dir":"Reference","previous_headings":"","what":"Find Task Neighborhood — task_graph_neighborhoods","title":"Find Task Neighborhood — task_graph_neighborhoods","text":"Find Task Neighborhood","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_neighborhoods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find Task Neighborhood — task_graph_neighborhoods","text":"","code":"task_graph_neighborhoods(g, nodes)"},{"path":"https://Genentech.github.io/checked/reference/task_graph_neighborhoods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find Task Neighborhood — task_graph_neighborhoods","text":"g task graph, produced task_graph_create() nodes Names nodes objects packages whose neighborhoods calculated.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":null,"dir":"Reference","previous_headings":"","what":"Sort Task Graph by Strong Dependency Order — task_graph_sort","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"Sort Task Graph Strong Dependency Order","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"","code":"task_graph_sort(g)"},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"g igraph::graph, expected contain node attribute type.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"igraph::graph g, vertices sorted preferred installation order.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_sort.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Sort Task Graph by Strong Dependency Order — task_graph_sort","text":"Cyclic dependencies possible. Cyclic dependencies disallowed hard dependencies CRAN today, though historical instances appeared CRAN. Installation priority based : Total dependency footprint (low high) Topology (leaf nodes first)","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":null,"dir":"Reference","previous_headings":"","what":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"packages progress, ensure next selected package already dependencies done.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"","code":"task_graph_which_satisfied( g, v = igraph::V(g), dependencies = TRUE, status = STATUS$pending )"},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"g dependency graph, produced task_graph_create(). v Names nodes objects packages whose satisfiability checked. dependencies dependencies types met node considered satisfied. status status name. Nodes v fill filtered consists nodes status.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"name next package prioritize","code":""},{"path":"https://Genentech.github.io/checked/reference/task_graph_which_satisfied.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Find the Next Packages Not Dependent on an Unavailable Package — task_graph_which_satisfied","text":"helpers defined particular use cases strictly rely task_graph_which_satisfied(), : task_graph_which_satisfied_strong() - List vertices whose strong dependencies satisfied. task_graph_which_check_satisfied() - List root vertices whose dependencies satisfied. task_graph_which_install_satisfied() - List install vertices whose dependencies satisfied","code":""},{"path":"https://Genentech.github.io/checked/reference/task_spec.html","id":null,"dir":"Reference","previous_headings":"","what":"Task specification — task_spec","title":"Task specification — task_spec","text":"Create task specification list consists details required run specific task.","code":""},{"path":"https://Genentech.github.io/checked/reference/task_spec.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Task specification — task_spec","text":"","code":"task_spec( alias = NULL, package_spec = NULL, env = options::opt(\"check_envvars\") )"},{"path":"https://Genentech.github.io/checked/reference/task_spec.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task specification — task_spec","text":"alias task alias also serves unique identifier task. package_spec package_spec object env environmental variables set separate process running specific task.","code":""},{"path":[]},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate A Rate Limiting Throttle Function — throttle","title":"Generate A Rate Limiting Throttle Function — throttle","text":"Generate Rate Limiting Throttle Function","code":""},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate A Rate Limiting Throttle Function — throttle","text":"","code":"throttle(interval = 0.2)"},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate A Rate Limiting Throttle Function — throttle","text":"interval interval (seconds) minimum interval throttle return TRUE.","code":""},{"path":"https://Genentech.github.io/checked/reference/throttle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate A Rate Limiting Throttle Function — throttle","text":"throttling function provided interval. called, returns logical value indicating whether throttle interval passed (TRUE interval yet passed).","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-025","dir":"Changelog","previous_headings":"","what":"checked 0.2.5","title":"checked 0.2.5","text":"Refine reverse suggested dependecy strategy.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-024","dir":"Changelog","previous_headings":"","what":"checked 0.2.4","title":"checked 0.2.4","text":"CRAN release: 2024-10-25 Fix check processes hanging forever system configurations. Remove whitespaces (\"[[:space:]]\") comparing potential issues skip false positives. Shortened many user-facing function names. general, uses reverse shortened rev, dependencies shortened deps, development shortened dev package shortened pkg. example, check_reverse_dependencies_development() shortened check_dev_rev_deps() (@dgkf-roche) Fix names enum function R lower 4.3. Add tests reverse dependency check use case. Make install_packages_process capture session’s available_packages_filters reuse installing packages ensure consistency main session filtering. Prettify output stripping excessive new lines. checked now depends options Expose ... allowing customization check subprocesses creating checks df. Force garbage collection scheduling task, make sure already finished processes removed memory.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-023","dir":"Changelog","previous_headings":"","what":"checked 0.2.3","title":"checked 0.2.3","text":"Use custom checked finisher’s instead processx finalizer’s cleaning finished processes avoid executing callbacks objects garbage collected. rev_dep_check_tasks_df add custom package value check associated release version package make sure, current release version package always fetched installed. Prevent results attempting read results unfinished checks.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-022","dir":"Changelog","previous_headings":"","what":"checked 0.2.2","title":"checked 0.2.2","text":"Clear unused utils functions (can_symlink, symlink_or_copy). Make sure output directory always created.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-021","dir":"Changelog","previous_headings":"","what":"checked 0.2.1","title":"checked 0.2.1","text":"Add results_to_file function.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-020","dir":"Changelog","previous_headings":"","what":"checked 0.2.0","title":"checked 0.2.0","text":"CRAN release: 2024-07-26 Change default private lib.loc value check_process R6 class NULL avoid staged installation failures. Terminate subprocesses run function interrupted comply CRAN requirements. Reorganize methods check_design making private. Remove warning possible problems isolation. Rename development_only parameter versions rev_dep_check_tasks_df Make sure check_reverse_dependencies works package available remote sources reverse dependencies. Add keep parameters print.checked_results_check_task_spec. Add error_on parameters results.check_design. Add $get_r_exit_status() method check install processes. Add warnings reporter whenever sub-processes non-zero exit status. Fix race condition reporting progress check processes.","code":""},{"path":"https://Genentech.github.io/checked/news/index.html","id":"checked-010","dir":"Changelog","previous_headings":"","what":"checked 0.1.0","title":"checked 0.1.0","text":"CRAN release: 2024-07-10 Package released CRAN","code":""}]
Maksymiuk S, Kelkhoff D (2024). checked: Systematically Run R CMD Checks. -R package version 0.2.4, +R package version 0.2.5, https://github.com/Genentech/checked, https://Genentech.github.io/checked/.
@Manual{, title = {checked: Systematically Run R CMD Checks}, author = {Szymon Maksymiuk and Doug Kelkhoff}, year = {2024}, - note = {R package version 0.2.4, + note = {R package version 0.2.5, https://github.com/Genentech/checked}, url = {https://Genentech.github.io/checked/}, }
NEWS.md
CRAN release: 2024-10-25
Fix check processes hanging forever in some system configurations.
vector of libraries used to check whether reverse dependency +check can return accurate results.
parameters passed to the task specs allowing to customize subprocesses.