Adding vignette + pkgdown website

[BatoolMM]

This is to fix #34

[RayStick]

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

[BatoolMM]

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

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.

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

[RayStick]

Thanks @BatoolMM
I had a quick look through and it looks good
I am not familiar with all of these steps so I don't know why all these files exist but if you are happy with the PR, please feel free to merge! We can then see if the website is working fine

[BatoolMM]

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]

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]

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]

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

[RayStick]

@all-contributors add @RayStick for pull request reviews

[allcontributors]

@RayStick

I've put up a pull request to add @RayStick! 🎉