Package: valtools 0.4.1

Ellis Hughes

valtools: Automate Validated Package Creation

Automate the steps necessary to create a validation ready package to make the process of validation simple. This includes setting up the specifications, test cases, test code, and validation report. Also provides tools to be able to execute the validation report from a variety of situations to provide documentation for validation.

Authors:Ellis Hughes [aut, cre], Eli Miller [aut], Marie Vendettuoli [aut], Peyman Eshghi [aut], Maya Gans [ctb], PHUSE [cph]

valtools_0.4.1.tar.gz
valtools_0.4.1.zip(r-4.5)valtools_0.4.1.zip(r-4.4)valtools_0.4.1.zip(r-4.3)
valtools_0.4.1.tgz(r-4.4-any)valtools_0.4.1.tgz(r-4.3-any)
valtools_0.4.1.tar.gz(r-4.5-noble)valtools_0.4.1.tar.gz(r-4.4-noble)
valtools_0.4.1.tgz(r-4.4-emscripten)valtools_0.4.1.tgz(r-4.3-emscripten)
valtools.pdf |valtools.html✨
valtools/json (API)
NEWS

# Install 'valtools' in R:
install.packages('valtools', repos = c('https://pharmaverse.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/phuse-org/valtools/issues

On CRAN:

6.67 score 51 stars 46 scripts 51 exports 109 dependencies

Last updated 16 days agofrom:892fbd02c8. Checks:OK: 1 ERROR: 6. Indexed: no.

TargetResultDate
Doc / VignettesOKNov 05 2024
R-4.5-winERRORNov 05 2024
R-4.5-linuxERRORNov 05 2024
R-4.4-winERRORNov 05 2024
R-4.4-macERRORNov 05 2024
R-4.3-winERRORNov 05 2024
R-4.3-macERRORNov 05 2024

Exports:vt_add_file_to_configvt_add_user_to_configvt_create_packagevt_create_packetvt_drop_file_from_configvt_drop_user_from_configvt_dynamic_referencervt_filevt_find_configvt_get_all_usersvt_get_child_filesvt_get_user_infovt_kable_change_logvt_kable_coverage_matrixvt_kable_function_editorsvt_kable_requirement_editorsvt_kable_risk_assessmentvt_kable_sig_tablevt_kable_test_case_editorsvt_kable_test_code_editorsvt_kable_test_code_resultsvt_kable_val_envvt_pathvt_render_tovt_render_validation_reportvt_run_test_code_filevt_scrape_change_logvt_scrape_coverage_matrixvt_scrape_function_editorsvt_scrape_requirement_editorsvt_scrape_risk_assessmentvt_scrape_sectionvt_scrape_sig_tablevt_scrape_tags_fromvt_scrape_test_case_editorsvt_scrape_test_code_editorsvt_scrape_val_envvt_use_change_logvt_use_configvt_use_reportvt_use_reqvt_use_test_casevt_use_test_codevt_use_validationvt_uservt_usernamevt_validate_buildvt_validate_installvt_validate_installed_packagevt_validate_reportvt_validate_source

Dependencies:askpassbase64encbrewbriobslibcachemcallrclicliprcolorspacecommonmarkcpp11crayoncredentialscurldescdevtoolsdiffobjdigestdownlitellipsisevaluatefansifarverfastmapfontawesomefsgenericsgertghgitcredsgluehighrhtmltoolshtmlwidgetshttpuvhttrhttr2inijquerylibjsonlitekableExtraknitrlabelinglaterlifecyclelubridatemagrittrmemoisemimeminiUImunsellopensslpillarpkgbuildpkgconfigpkgdownpkgloadpraiseprettyunitsprocessxprofvispromisespspurrrR6raggrappdirsrcmdcheckRColorBrewerRcppremotesrlangrmarkdownroxygen2rprojrootrstudioapirversionssassscalessessioninfoshinysourcetoolsstringistringrsvglitesyssystemfontstestthattextshapingtibbletidyselecttimechangetinytexurlcheckerusethisutf8vctrsviridisLitewaldowhiskerwhoamiwithrxfunxml2xopenxtableyamlzip

Starting New Validation Package using {valtools}

Rendered fromstarting-validated-package.Rmdusingknitr::rmarkdownon Nov 05 2024.

Last update: 2021-05-11
Started: 2021-05-11

Validating External Resources with {valtools}

Rendered fromvalidating-external-resources.Rmdusingknitr::rmarkdownon Nov 05 2024.

Last update: 2021-11-04
Started: 2021-11-04

Readme and manuals

Help Manual

Help pageTopics
Dynamic Reference Renderingdynamic_reference_rendering
Scrape Roxygen blocksscrape_roxygen
Add validation file ordering to validation config filevt_add_file_to_config vt_add_user_to_config vt_drop_file_from_config vt_drop_user_from_config vt_get_user_info vt_user vt_use_config
print files for report generationvt_file
Get all users from validation config file without knowing usernamesvt_get_all_users
Identify ordering of validation or user-designated child filesvt_get_child_files
Kable handler for output of 'vt_scrape_coverage_matrix'vt_kable_coverage_matrix
Kable defaults for rendering validation reportvt_kable_sig_table
Generates kable code for validation environment detailsvt_kable_val_env
Use dynamic file paths in a validation.vt_find_config vt_path
output to render kable tovt_render_to
provide a nice wrapper to set states around rendervt_render_validation_report
Evaluate the test code filevt_kable_test_code_results vt_run_test_code_file
Scrape change log from a validation projectvt_kable_change_log vt_scrape_change_log vt_use_change_log
Scrape "coverage" tag in test code to generate mappingvt_scrape_coverage_matrix
Scrape authorship informationvt_kable_function_editors vt_kable_requirement_editors vt_kable_test_case_editors vt_kable_test_code_editors vt_scrape_function_editors vt_scrape_requirement_editors vt_scrape_test_case_editors vt_scrape_test_code_editors
Scrape "riskAssessment" tag in requirements to generate tablevt_kable_risk_assessment vt_scrape_risk_assessment
Retrieve the value block of a custom section tagged via roxygen2vt_scrape_section
Generate a signature table for a validation reportvt_scrape_sig_table
Retrieve roxygen tags as a data.frame from requirements, test cases, test code and functionsvt_scrape_tags_from
Retrieve validation environmentvt_scrape_val_env
Create validation report from templatevt_use_report
Create a validation requirement, test case, or test code filevt_use_req vt_use_test_case vt_use_test_code
Create a validation structurevt_create_package vt_create_packet vt_use_validation
Get current usernamevt_username
Validate a packagevt_validate_build vt_validate_install vt_validate_installed_package vt_validate_report vt_validate_source