Report

[llrs]

Creating the report, takes the template from insightsengineering/thevalidatoR

Closes #2

[llrs-roche]

This reports works but there are some corner cases to fix:

• Deal with riskmetric failures (see riskmetric issues #3 )
• Parametrize which riskmetric assessment to perform
• add branding to the quarto template (requires quarto 1.6)
• Be more selective with what to include: I've been very exhaustive with R session, environment and options.

[Zhenglei-BCS]

Template report can be rendered correctly, on both windows and ubuntu.

Could I edit the documentation directly?

The assessment function is designed to process an object created by the pkg_assess() function from the riskmetric package. The function takes this assessment object and converts it into a simplified data.frame without scoring the assessment. The function ensures that the input is of the correct type and processes specific elements using the risk_error function.

I cannot generate the vignettes on my local machine due to this line:

dplyr_pkg_ref <- riskmetric::pkg_ref("dplyr", lib.loc = "inst/source/dplyr")

Some other suggestions:

1. Perhaps we can have child qmd files, like riskmetric calculations can be included or excluded from the report, depending whether a package meta file is available.
2. Another template should be built for one pdf report for all packages in the image (that Pavel generated with the github actions) with simple information like package name, version, some basic risk metric.

[llrs-roche]

Yes, feel free to commit and push to the branch! I took too much shortcuts and neglected a bit the documentation.

I haven't tested building the package or generating vignettes as some of them assume certain data or took too long (until I discovered that riskmetric was checking the package again) . Would you like to work on that?

1. Great idea! This will make easier handling errors or failures.
2. So we could have one report for individual package and one general for the whole repository? This looks like a good idea. Please go ahead on this. Do you want to be on the meeting with Pavel on Monday morning?

[Zhenglei-BCS]

I haven't tested building the package or generating vignettes as some of them assume certain data or took too long (until I discovered that riskmetric was checking the package again) . Would you like to work on that?

Not sure about this vignettes, I will see what I can do.

1. Great idea! This will make easier handling errors or failures.
2. So we could have one report for individual package and one general for the whole repository? This looks like a good idea. Please go ahead on this. Do you want to be on the meeting with Pavel on Monday morning?

Yes, one general for all packages, one for individual report (maybe also for a filtered list of packages based on the previous one) where the user can have more control on what criteria are used, what should be included in the report. I do have time on Monday, but I am not so good at coding and not sure how much I can contribute there.

I feel we can merge the pull request and work on these afterwards, then create a new pull request.