nmfs-ost / nmfs-ost/fishdictionary

access R package documentation through a {shiny} app

Open
#25 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
5
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Below are some stack exchange / blog posts about how to access .Rd files from an R package in a shiny server setting. This would be useful if we used .R and resulting .Rd files to document terms instead of json files.

Contributor guide

No contributing guide indexed for this repository

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 reviewing the linked Stack Overflow, blog, and rdrr.io examples for displaying R package documentation in a Shiny app. Then inspect how the project currently represents documentation with JSON, if present. Done should be a decided and documented approach for replacing or integrating that representation with .R and generated .Rd files.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.