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

change the name from browse-SAIL to browse-metadata #24

Closed RayStick closed 8 months ago

RayStick commented 8 months ago

Change the name of the repo and the package to browse-metadata

Due to this sentence in the README:

In theory, this package should work for any dataset listed on the Health Data Research Gateway (not just SAIL) as long as a json metadata file can be downloaded. In practice, it has only been tested on a limited number of metadata files for SAIL databank.

BatoolMM commented 8 months ago

This was addressed in #25 but the name of the repo and RProj is still the old one. I don't want to change these at this stage in case it messed up other things.

RayStick commented 8 months ago

Oops, good point! I just changed the repo name ... I think it's fine, but you might just need to change the name of your local repo to match. Leave this with me - I will check all the other places that need to be changed.

BatoolMM commented 8 months ago

I am trying to review the installation instructions to improve it as in #26 but I am getting an error for a while because the DESCRIPTION file seems to have a dash in the name of the package.

I was looking it up and found this:

There are three formal requirements: the name can only consist of letters, numbers and periods, i.e., .; it must start with a letter; and it cannot end with a period. Unfortunately, this means you can’t use either hyphens or underscores, i.e., - or _, in your package name. I recommend against using periods in package names because it has confusing connotations (i.e., file extension or S3 method). https://community.rstudio.com/t/analysis-package-naming-or-can-package-name-differ-from-rproj-name/9421

I was looking to see if see if there are R Pcakges with hyphen - but I can't seem to remember. Is it alright if I change it to browseMetadata?

RayStick commented 8 months ago

Ah, good point! Yes you can change it to browseMetadata (see all the places above in the checklist of this issue) Thanks!

BatoolMM commented 8 months ago

Thank you :) - I have changed them in a new PR #42