Test the installation of sa4ss to build the template pdf.
session_test()A list object is returned with two entries.
The first entry, session_info,
contains stored information about your work session.
The typical output from Sys.getenv is augmented with information pertinent
to the sa4ss package and compiling accessible pdf documents.
The second entry, tried, is the output from tryCatch when attempting
to compile the .Rmd files into a pdf using bookdown::render_book.
If the function fails to produce a successful pdf, then a
utils::bug.report is generated and users are sent to github issues,
where they can fill out an issue based on the installation issue template.
sa4ss relies on a lot of back-end functionality that typical R packages
do not require. Ensuring that these are installed properly is facilitated
when you use Rstudio because the developers of Rstudio have put in a lot of
work towards making it easy for users to compile documents. sa4ss also relies
on sed which is available in the tools provided by R, i.e., rtools40, but
not always available in your path.
The premise of this function is to store information if the pdf build is not successful that is of use to the developers. If you provide the generic output that is returned to the developers, then they will be able to help you and future individuals like yourself work through installation problems. So, thank you for being willing to help.
if (FALSE) { # \dontrun{
localtest <- session_test()
} # }