README.Rmd

---
output: github_document
params:
  github: the-mad-statter
  package: edu.wustl.medicine.josp.xlam
  font: Rockwell
  font_ext: ttf
  color: "#a51417"
  img_dir: "img"
---
  
<!-- README.md is generated from README.Rmd. Please edit that file -->
  
```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "img",
  out.width = "100%",
  eval = FALSE
)

make_shields_io_your_badge <- 
  function(label,
           message,
           color) {
    URLencode(
      sprintf("https://img.shields.io/static/v1?label=%s&message=%s&color=%s", 
              label, 
              message, 
              color)
    )
  }

make_under_development_badge <- 
  function(github = params$github, 
           package = params$package) {
    sprintf(
      paste0(
        "[![Under Development](",
        make_shields_io_your_badge("status", "under development", "red"), 
        ")](https://github.com/%s/%s)"
      ), 
      github, package
    )
  }

make_release_badge <- 
  function(github = params$github, 
           package = params$package) {
    sprintf(
      paste0(
        "[![](",
        "https://img.shields.io/github/v/release/%s/%s?include_prereleases",
        ")](https://github.com/%s/%s/releases)"
      ), 
      github, package, github, package
    )
  }

make_last_commit_badge <- 
  function(branch = "main", 
           github = params$github, 
           package = params$package) {
    sprintf(
      paste0(
        "[![Last Commit]",
        "(https://img.shields.io/github/last-commit/%s/%s.svg)]",
        "(https://github.com/%s/%s/commits/%s)"
      ), 
      github, package, github, package, branch
    )
  }

make_github_action_badge <- 
  function(name, 
           yaml = paste0(name, ".yaml"), 
           github = params$github, 
           package = params$package) {
    sprintf(
      paste0(
        "[![%s]",
        "(https://github.com/%s/%s/actions/workflows/%s/badge.svg)]", 
        "(https://github.com/%s/%s/actions/workflows/%s)"
      ), 
      name, github, package, yaml, github, package, yaml
    )
  }
```

```{r sticker, eval=FALSE, include=FALSE}
library(extrafont)
library(hexSticker)

sticker(
  subplot = paste(params$img_dir, "briefcase.png", sep = "/"), 
  s_x = 1, 
  s_y = 1.25, 
  s_width = 0.5, 
  s_height = 0.5, 
  package  = params$package, 
  p_x = 1, 
  p_y = 0.65, 
  p_color = params$color, 
  p_family = params$font, 
  p_size = 2.5, 
  h_fill = "#ffffff", 
  h_color = "#a51417", 
  url = paste("github.com", params$github, params$package, sep = "/"),
  u_color = params$color, 
  u_family = params$font, 
  u_size = 0.85, 
  u_x = 1.005, 
  u_y = 0.1,
  filename = paste0(params$img_dir, "/", params$package, "_hex.png")
)
```

# `r params$package` <img src="`r params$img_dir`/`r params$package`_hex.png" align="right" width="125px" />

<!-- badges: start -->
`r make_release_badge()`
`r make_last_commit_badge()`
<!-- badges: end -->
  
## Overview

This repository contains a Microsoft Excel add-in which defines additional functions for the [Joint Office of Strategic Planning at Washington University in St. Louis](https://medicine.wustl.edu/josp/).

<br />
  
## Installation
  
1. Download the latest [release](https://github.com/`r params$github`/`r params$package`/releases)
2. Place the "edu.wustl.medicine.josp.xlam" file in C:\\Users\\&lt;your account&gt;\\AppData\\Roaming\\Microsoft\\AddIns
3. Right click the file, select Properties, and unblock the file
4. Open Excel
5. Click Options
6. Click Add-ins
7. Make sure "Excel Add-ins" is selected in the Manage drop down box and click the Go button
8. Check the box next to "`r params$package`" and click the OK button

You should now have new functions which all start with JOSP (e.g., JOSP_BJH_MKTS_TER1_2019()).

<br />
  
## Code of Conduct
  
Please note that the `r params$package` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

<br />
  
## About
  
### Washington University in Saint Louis <img src="`r params$img_dir`/brookings_seal.png" align="right" width="125px"/>
  
Established in 1853, [Washington University in Saint Louis](https://www.wustl.edu) is among the world's leaders in teaching, research, patient care, and service to society. Bosting 24 Nobel laureates to date, the University is ranked 7th in the world for most cited researchers, received the 4th highest amount of NIH medical research grants among medical schools in 2019, and was tied for 1st in the United States for genetics and genomics in 2018. The University is committed to learning and exploration, discovery and impact, and intellectual passions and challenging the unknown.