Merge pull request #83 from aim-rsf/version-1.0.0

Update README.md

CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 message: "If you use this package, please cite it as below."
 title: "browseMetadata"
-version: 0.1.0
+version: 1.0.0
 date-released: 2024-01-29
 authors:
   - family-names: "Rachael"

DESCRIPTION

@@ -1,17 +1,11 @@
 Package: browseMetadata
 Type: Package
 Title: Browses available metadata, to catergorise or label each variable in a dataset
-Version: 0.1.0
+Version: 1.0.0
 Authors@R: 
     person("Rachael", "Stickland", email = "[email protected]", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-3398-4272"))
 Maintainer: Rachael Stickland <[email protected]>
-Description: This package currently contains one function, domain_mapping.
-    This function takes two inputs. One input is a metadata file that has been downloaded in json format from modelcatalogue.cs.ox.ac.uk/hdruk_live.
-    The second input is a csv file created by the user, that lists research domains of interest. 
-    The function will read in the metadata file for a chosen dataset, loop through all the variables, and ask the user to catergorise/label each variable as belonging to one or more domains. 
-    The domains will appear in the Plots tab and information about the dataset will be printed to the R console, for the user's reference in making these categorisations. 
-    A log file will be saved with the catergorisations made. To speed up this process, some auto-categorisations will be made by the function for commonly occurring variables; 
-    these should be verified by the user by checking the csv log file. Example inputs are provided within the package data, for the user to run this function in a demo mode.
+Description: See https://github.com/aim-rsf/browseMetadata/main/README.md
 License: GPL (>= 3)
 Encoding: UTF-8
 LazyData: true

README.md

@@ -335,7 +335,7 @@ and other kinds of works. For more information, please refer to
 To cite package ‘browseMetadata’ in publications use:
 
 > Stickland R (2024). browseMetadata: Browses available metadata, to
-> catergorise/label each variable in a dataset. R package version 0.1.0.
+> catergorise/label each variable in a dataset. R package version 1.0.0
 
 A BibTeX entry for LaTeX users is
 
@@ -344,7 +344,7 @@ A BibTeX entry for LaTeX users is
     title = {browseMetadata: Browses available metadata, to catergorise/label each variable in a dataset},
     author = {Rachael Stickland},
     year = {2024},
-    note = {R package version 0.1.0},
+    note = {R package version 1.0.0},
     doi = {https://doi.org/10.5281/zenodo.10581500},
   }
 ```

browseMetadata.Rproj

@@ -1,4 +1,4 @@
-Version: 1.0
+Version: 1.0.0
 
 RestoreWorkspace: Default
 SaveWorkspace: Default