Description
Date accepted: 2025-03-04
Submitting Author Name: Rachael Stickland
Submitting Author Github Handle: @RayStick
Other Package Authors Github handles: (comma separated, delete if none) @BatoolMM, @Rainiefantasy
Repository: https://github.com/aim-rsf/mapmetadata
Version submitted:
Submission type: Standard
Editor: @maelle
Reviewers: @ymansiaux, @Lextuga007
Archive: TBD
Version accepted: TBD
Language: en
- Paste the full DESCRIPTION file inside a code block below:
Type: Package
Package: mapmetadata
Title: Map health metadata onto predefined research domains
Version: 3.0.0
Authors@R: c(
person("Rachael", "Stickland", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-3398-4272")),
person("Batool", "Almarzouq", role = "ctb",
comment = c(ORCID = "0000-0002-3905-2751")),
person("Mahwish", "Mohammad", role = "ctb",
comment = c(ORCID = "0009-0004-5295-0726")),
person("Daniel", "Delbarre", role = "ctb",
comment = c(ORCID = "0000-0003-4633-4252")),
person("Nida", "Ziauddeen", role = "ctb",
comment = c(ORCID = "0000-0002-8964-5029"))
)
Description: Prior to gaining full access to health datasets, explore
publicly available metadata and map metadata onto predefined research
domains. This package uses structural metadata files downloaded from
the Health Data Research Gateway (https://healthdatagateway.org/en).
In theory, any metadata file with the same structure as the files
downloaded from this gateway can be used with this package, but the
package has been developed and tested on metadata files from this
gateway only.
License: GPL (>= 3)
URL: https://aim-rsf.github.io/mapmetadata/
BugReports: https://github.com/aim-rsf/mapmetadata/issues
Depends:
R (>= 2.10)
Imports:
cli,
dplyr,
ggplot2,
gridExtra,
htmlwidgets,
plotly,
tidyr
Suggests:
devtools,
knitr,
mockery,
rmarkdown,
testthat (>= 3.0.0),
withr
VignetteBuilder:
knitr
Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.3.2
Scope
-
Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):
- data retrieval
- data extraction
- data munging
- data deposition
- data validation and testing
- workflow automation
- version control
- citation management and bibliometrics
- scientific software wrappers
- field and lab reproducibility tools
- database software bindings
- geospatial data
- text analysis
-
Explain how and why the package falls under these categories (briefly, 1-2 sentences):
This package is related to data access, as interacting with health metadata can help a researcher/research group decide what datasets to access for their research, and be more informed when writing their data access request. It involves data validation checks as it checks for completeness of metadata, and visualizes this.
- Who is the target audience and what are scientific applications of this package?
Any users of health metadata, specifically for research projects that are using large population datasets, with many latent variables (research domains/concepts) and they need to investigate which variables in the datasets map onto their research domains of interest.
- Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?
Not that I am aware of
- (If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?
Not Applicable
- If you made a pre-submission inquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.
Not Applicable
- Explain reasons for any
pkgcheckitems which your package is unable to pass.
Technical checks
Confirm each of the following by checking the box.
- I have read the rOpenSci packaging guide.
- I have read the author guide and I expect to maintain this package for at least 2 years or to find a replacement.
This package:
- does not violate the Terms of Service of any service it interacts with.
- has a CRAN and OSI accepted license.
- contains a README with instructions for installing the development version.
- includes documentation with examples for all functions, created with roxygen2.
- contains a vignette with examples of its essential functions and uses.
- has a test suite.
- has continuous integration, including reporting of test coverage.
Publication options
-
Do you intend for this package to go on CRAN?
-
Do you intend for this package to go on Bioconductor?
-
Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
MEE Options
- The package is novel and will be of interest to the broad readership of the journal.
- The manuscript describing the package is no longer than 3000 words.
- You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see MEE's Policy on Publishing Code)
- (Scope: Do consider MEE's Aims and Scope for your manuscript. We make no guarantee that your manuscript will be within MEE scope.)
- (Although not required, we strongly recommend having a full manuscript prepared when you submit here.)
- (Please do not submit your package separately to Methods in Ecology and Evolution)
Code of conduct
- I agree to abide by rOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.