AlexsLemonade / AlexsLemonade/refinebio-examples

[Investigation/Discussion] How should we format API usage examples?

Open
#139 1 comment 0 reactions 0 assignees View on GitHub
advanced topics discussion future thoughts
Dominant language
HTML
Stars
11
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Eventually we want to include examples on how to use the refine.bio API. I have an example using python to generate quant-only datasets, which I wrote for one of our users.

How should we format these examples? For all of our other examples we are using Rmarkdown, but would that work/be the best approach for API examples too?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing Rmarkdown examples and the Python example for generating quant-only datasets. Compare how each presents API usage and determine whether Rmarkdown is suitable or another format is needed. Done means documenting a decided format and its rationale for future refine.bio API examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, r
Domain
api, documentation
Issue type
Documentation
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.