This R package was created to help a researcher browse the health datasets in SAIL databank. It has scope to be applied to other health datasets. It is intended to be useful in the earlier stages of a project. When a research team has not yet got access to the data they can still browse the metadata, and address such questions as:
❓ what datasets are available?
-❓ what datasets do I need for my research question?
-❓ which variables within these datasets map onto my research domains of interest? (e.g. socioeconomic factors, childhood adverse events, medical diagnoses, culture and community)
+This R package helps a researcher browse health datasets in SAIL databank. It has scope to be applied to other health datasets. It is useful in the earlier stages of a project; prior to data access, researchers can use the metadata to browse and categorise variables, addressing such questions as:
Beyond browsing: Variables are categorised into research domains. The output file containing the categorisations can be used as input to later analyses, to filter and visualise variables based on category labels.
There are many existing tools that allow you to browse metadata for health datasets, read more here.
browseMetadata package?
diff --git a/pkgdown.yml b/pkgdown.yml
index 85e9b92..85e82e8 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.1.0
pkgdown_sha: ~
articles:
browseMetadata: browseMetadata.html
-last_built: 2024-07-29T08:12Z
+last_built: 2024-08-30T09:47Z
urls:
reference: https://aim-rsf.github.io/browseMetadata/reference
article: https://aim-rsf.github.io/browseMetadata/articles
diff --git a/search.json b/search.json
index 4f2598b..f581970 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to browseMetadata","title":"Contributing to browseMetadata","text":"warmly welcome contributions browseMetadata project! document provides guidelines contributing repository.","code":""},{"path":[]},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"reporting-issues","dir":"","previous_headings":"How to Contribute","what":"Reporting Issues","title":"Contributing to browseMetadata","text":"Bug Reports: find bug, please open issue clear description problem steps reproduce . Feature Requests: Suggestions new features improvements always welcome. Please open issue discuss ideas.","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"making-changes","dir":"","previous_headings":"How to Contribute","what":"Making Changes","title":"Contributing to browseMetadata","text":"Fork Repository: Start forking repository GitHub account. Create Feature Branch: Create new branch feature fix. Make Changes: Implement changes, adhering coding standards practices outlined . Test Changes: Ensure changes break existing functionality. Submit Pull Request: Open pull request feature branch main branch original repository.","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"coding-standards","dir":"","previous_headings":"How to Contribute","what":"Coding Standards","title":"Contributing to browseMetadata","text":"Follow tidyverse style guide R code. Write clear, readable, maintainable code. Include comments documentation needed.","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"documentation","dir":"","previous_headings":"How to Contribute","what":"Documentation","title":"Contributing to browseMetadata","text":"Update README documentation necessary. Clearly describe changes ’ve made benefits.","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"contributing-to-the-r-package---as-an-author-or-reviewer-of-a-pr","dir":"","previous_headings":"","what":"Contributing to the R Package - as an author or reviewer of a PR","title":"Contributing to browseMetadata","text":"contribution involves changes R package (author reviewer PR), specific guidelines, assuming using RStudio editor: Clone GitHub repository locally ensure branches need date remote. > R Studio, can clone clicking File > New Project..., select Version Control, choose Git. Enter repository URL (e.g., https://github.com/aim-rsf/browseMetadata), select directory clone repository , click Create Project. Git tab workspace. Git tab, move branch want make changes (review test changes someone else). Ensure current working directory R package directory cloned (getwd() check setwd() change). Run devtools::load_all() R console. see ℹ Loading browseMetadata returned. Test function runs running domain_mapping() R console. Make changes (review changes made others), commit changes way choose interact git locally! run issues branches seeming date R Studio workspace, consider running remove.packages(\"browseMetadata\") trying steps , case previously installed package library getting way somehow.","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"working-with-package-data","dir":"","previous_headings":"Contributing to the R Package - as an author or reviewer of a PR","what":"Working with Package Data","title":"Contributing to browseMetadata","text":"Creating .rda Files: create .rda files data directory package, use following command R: Replace dataname actual name data. Viewing Package Data: view data included browseMetadata package, execute: Loading Package Data: load specific data package, use: , replace dataname name data wish load.","code":"usethis::use_data(dataname) data(package='browseMetadata') data(dataname)"},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"building-documentation","dir":"","previous_headings":"Contributing to the R Package - as an author or reviewer of a PR","what":"Building Documentation","title":"Contributing to browseMetadata","text":"Generating Documentation Files: build documentation files package, use roxygen2 package: generate necessary documentation based roxygen comments R code.","code":"library(roxygen2) roxygenise()"},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"testing-your-changes","dir":"","previous_headings":"Contributing to the R Package - as an author or reviewer of a PR","what":"Testing Your Changes","title":"Contributing to browseMetadata","text":"Ensure changes break existing functionality. Run existing tests, consider adding new tests cover changes.","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"submitting-changes","dir":"","previous_headings":"Contributing to the R Package - as an author or reviewer of a PR","what":"Submitting Changes","title":"Contributing to browseMetadata","text":"making changes, test thoroughly. Update documentation reflect changes, applicable. Submit pull request clear description changes benefits bring package.","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/CONTRIBUTING.html","id":"questions-or-need-help","dir":"","previous_headings":"","what":"Questions or Need Help?","title":"Contributing to browseMetadata","text":"questions need help, feel free open issue discussion reach maintainers directly. Thank contributing browseMetadata!","code":""},{"path":"https://aim-rsf.github.io/browseMetadata/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc.