The goal of nfportalutils
is to provide convenience functions for project and (meta)data management in the NF-OSI data portal scope.
Currently, develop
branch is default so package install and docs refer to code in this branch.
:point_right: Package documentation!
You can install nfportalutils
from here:
remotes::install_github("nf-osi/nfportalutils")
The package interops with the Python synapse client via reticulate. You will have to download the Python synapse client first.
vignette("annotate-nf-processed-data", package = "nfportalutils")
to view.develop
.develop-synapser
where interop tries to transition to synapser
.
However, current coexistence makes development a bit tricky so consult first before trying new developments there.develop
and make changesdevtools::check(vignettes = FALSE)
early and often, and definitely before submitting a PRdevelop
; this will run R-CMD-CHECK
and pkgdown
devtools::check(vignettes = FALSE)
early and often.ERRORS
and WARNINGS
.NOTES
that need to be resolved. _pkgdown.yml
.pkgdown::build_site()
.Please note that the nfportalutils project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.