connectapi icon indicating copy to clipboard operation
connectapi copied to clipboard

Feature request: render content with user-defined parameters

Open fh-kpikhart opened this issue 1 year ago • 2 comments

In the Connect UI, it is possible to adjust parameters of a report and re-render it, without saving those parameters as a new Variant (Input panel > Run Report button). Is it possible to expose that ad-hoc render capability, with custom parameters, as a connectapi method?

In other words: rmarkdown::render() takes a params argument. Can connectapi's Variant$render() do the same?

As far as I know, Variant$render() only supports rendering a saved Variant. However, creating a new Variant is cumbersome and manual (cannot be done programmatically).

fh-kpikhart avatar Jul 07 '23 20:07 fh-kpikhart

Parameters are not configurable nor specifiable using the API. Unfortunately, a Shiny application is currently used for that parameter configuration.

We definitely want to make the entire parameter management lifecycle better.

We are already tracking this feature request internally; it will be included in connectapi once it is is available in the Posit Connect API.

aronatkins avatar Jul 07 '23 20:07 aronatkins

This feature would definitely be useful. The simple use-case is a parameterized rmarkdown document (with or without a "Schedule") that can be rerendered with caller-defined parameters. I need to be able to run this several times over a report-cycle with different parameters, and since I don't use RStudio IDE, I see no way to easily add variants from the caller.

r2evans avatar Sep 07 '24 17:09 r2evans