Giters

aim-rsf / browseMetadata

An R package to help a researcher browse metadata for health datasets and categorise variables based on research domains

Home Page:https://aim-rsf.github.io/browseMetadata/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Improve README Structure

BatoolMM opened this issue · comments

commented

Improve README Structure

Description:

The current README is longer than the average README for an R package (or at least the ones I use). This may impact readability and navigation. In the future, we might consider the following improvements:

  1. Add a Table of Contents
  2. Remove Redundant Text
  3. Move Details to Tutorials Section

This is not urgent or very important at this point. However, I found myself struggling a bit with it last night, though it could just be me.

commented

Great suggestions. I like the idea of making the README shorter, and linking to a longer more in depth tutorial on github pages perhaps or read-the-docs.