posit-dev / posit-dev/connectapi

Trigger rendering with parameters

Open
#150 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

need connect feature
Dominant language
R
Stars
54
Forks
27
Avg merge
1d 3m
Merged PRs (30d)
1

Description

👋 thanks for this amazing package. So useful.

This is a great workflow to trigger a render of an rmarkdown document. However I can't see any way to trigger that rendering with parameters. So in a typical workflow we might do:

rmarkdown::render("report.Rmd", params = list(var1 = "val"))

and in my head I'd expect something like this to work:

connectapi::variant_render(rmd_content_variant, params = list(var1 = "val"))

So my question is, is there a path to passing parameters to a remote call of a parameterized report?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining connectapi::variant_render and the existing remote-render workflow, then compare the requested behavior with rmarkdown::render("report.Rmd", params = list(var1 = "val")). Determine whether the Posit Connect API supports passing parameters and define tests or acceptance criteria for a parameterized remote render; no files or tests are named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.