Skip to content

Commit

Permalink
readme: add short section on external scores
Browse files Browse the repository at this point in the history
  • Loading branch information
kyleam committed Aug 12, 2024
1 parent bc4ab1a commit 43d391e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,7 @@ browseURL(pdf_sum_path)
The report provides additional context, session info, proof points, etc., but will render a table that looks like the one below:

<img src="man/figures/summary_tab.png" align="center" style = "width:750px;" />

## Rendering scorecards for non-R packages

The workflow described above focuses on **R** packages. Generating scorecards for other types of packages is also supported. In this case, the scoring happens outside of `mpn.scorecard`, and a directory of results is fed to `render_scorecard`. The required input format is described at [`?external_scores`](https://metrumresearchgroup.github.io/mpn.scorecard/reference/external_scores.html).
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,12 @@ The report provides additional context, session info, proof points,
etc., but will render a table that looks like the one below:

<img src="man/figures/summary_tab.png" align="center" style = "width:750px;" />

## Rendering scorecards for non-R packages

The workflow described above focuses on **R** packages. Generating
scorecards for other types of packages is also supported. In this case,
the scoring happens outside of `mpn.scorecard`, and a directory of
results is fed to `render_scorecard`. The required input format is
described at
[`?external_scores`](https://metrumresearchgroup.github.io/mpn.scorecard/reference/external_scores.html).

0 comments on commit 43d391e

Please sign in to comment.