posit-dev / posit-dev/connect-extensions

Replace stock-report with a new R Markdown example, fold portfolio-report into it

Open
#386 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
10
Forks
8
Avg merge
5d 18h
Merged PRs (30d)
1

Description

Replace stock-report with a new R Markdown example: clinical-trial enrollment & adverse-event report. Fold relevant parts of portfolio-report (parameterized-Rmd lesson, including params + flexdashboard + blastula + xlsx) into it before deleting standalone portfolio-report.

Here is a non-exhaustive list of things we'll want to make sure are completed:

  • README: rewrite into a genuinely useful doc: what the tool does, who it's for, setup/configuration, and how to use it.
  • Well-commented source: comments should explain the why, not just the what.
  • Title: in Framework: Functionality form.
  • Description: concise; states the functionality and value. Where relevant, names a themed industry with an "applies to any …" cue.

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 inspecting the existing stock-report and portfolio-report examples and their README files, then trace the parameterized-Rmd lesson and its params, flexdashboard, blastula, and xlsx pieces. Done means a clinical-trial enrollment and adverse-event report replaces stock-report, portfolio-report is removed, and the README, comments, title, and description meet the stated requirements.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, r
Domain
data, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.