search

aim-rsf / browseMetadata

An R package to help a researcher browse metadata for health datasets and categorise variables based on research domains
https://aim-rsf.github.io/browseMetadata/
GNU General Public License v3.0
3 stars 1 forks source link

Adding vignette + pkgdown website #52

Closed BatoolMM closed 8 months ago

BatoolMM commented 8 months ago

This is to fix #34

RayStick commented 8 months ago

This looks great @BatoolMM Let me know when it is ready to review

BatoolMM commented 8 months ago

This will create an initial GH page for the pkg. it looks like this:

Screenshot 2024-01-10 at 18 20 30

It has "getting started" a page that goes into more detail by showing the vignettes. I added the 'Getting started with metadata' and 'Getting Started Guide for browseMetadata R Package' a bit repetitive to what already on the main page but that's expected from vignettes. It can be developed further but this initial PR is ready for review.

Screenshot 2024-01-10 at 18 23 22

Run pkgdown::build_site() to view the page locally, can't deploy it until the repo is public.

BatoolMM commented 8 months ago

The reason that many files modified because I used the lintr which corrected some formatting according to best practices and the other files are HTML that are generated using the YAML file for pkgdown. I will merge it now so I can test the deployment again, thank you @RayStick !

RayStick commented 8 months ago

The reason that many files modified because I used the lintr which corrected some formatting according to best practices and the other files are HTML that are generated using the YAML file for pkgdown. I will merge it now so I can test the deployment again, thank you @RayStick !

Yeah I could see a lot was to do with linting - all good! It was mostly the HTML stuff that I am less familiar with. Thanks Batool =D

BatoolMM commented 8 months ago

Hi @RayStick, the deployment is working here, I added to README. If you clicked on 'Getting Started', you will see "Getting started with metadata" and resources you added, there is also repetition similar to main page (around how to install pkg) but I see that with other pkgs docs, we can always polish them.

The docs for the functions and data is within "References". We can also in the future add short tutorials but not priority now. I am travelling today so I won't do anything until Monday.

RayStick commented 8 months ago

Thanks for this Batool, I can see it. This is a great start 🚀