Customize pin landing page

[akgold]

Make it easier to customize the landing page of a pin on RSC.

I believe you can currently provide a custom index.html, but this isn't well-documented. Would be really nice to be able to provide an object (nested list? json blob? yml?) that then would get auto-rendered into index.html for landing page.

Perhaps based on metadata as in #369?

[hadley]

Just removed this existing advice from the docs:

Customizing

A pin is displayed in RStudio Connect with an auto-generated page showcasing
instructions for getting the pin and a preview of the dataset, this page can
be customized as follows:

1. Locate the file with system.file("views/data/index.html", package = "pins")
2. Copy the file to a new location and make any changes to it.
3. Set the file path as an option using Sys.setenv(RSCONNECT_HTML_PATH = <your index>).
4. Pin a dataset normally.

[hadley]

The HTML preview will soon look like this:

What other info do you want?

[akgold]

I think this is great as the default. Especially for non-rectangular data, it's easy to imagine wanting to put other things on the landing page (e.g. model diagnostic plots). I don't think pins necessarily needs to provide that for me...but if it could provide an easy way to customize index.html, that'd be awesome.

[hadley]

The place to start is probably just a blob of markdown or html that's added to the index HTML index.

(Random thought: should also use expanded <details> on this page)

[kmasiello]

A customized (rmd- or qmd-based) index.html would enable more robust information about the pin to be presented, such as:

• data dictionary
• data validation results (i.e., from pointblank)
• assumptions, limitations, etc.

Encouraging better documentation around the pin and appropriate usage is analogous to the vetiver model card.