Skip to content

CRAN prep: Add renv and update package metadata #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafdoodle merged 4 commits into from
Oct 25, 2025
Merged

CRAN prep: Add renv and update package metadata #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
32135cb
Clean final commit for CRAN prep fixes
DougManuel Oct 17, 2025
5993482
Style code (GHA)
DougManuel Oct 17, 2025
bc7c8ce
Set eval = FALSE for chunks involving rec_with_table() to shorten CMD…
rafdoodle Oct 24, 2025
f1bd365
Updates env setup for package reproducibility
DougManuel Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .Rbuildignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,11 @@
^Meta$
^.quarto
^_freeze
^\.claude$
.*\.log$
^renv$
^renv\.lock$
^test_vignettes\.R$
^test_vignettes_with_timeout\.sh$
^vignette_.*\.txt$
^vignette_.*\.log$
18 changes: 18 additions & 0 deletions .Rprofile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Activate renv for reproducible package management
source("renv/activate.R")

# Use binary packages (no compiler needed)
# Posit Package Manager provides binaries for faster installation
options(
pkgType = "binary",
repos = c(CRAN = "https://packagemanager.posit.co/cran/latest")
)

# Warn if R version is below the package floor
if (getRversion() < "4.0") {
warning(
"chmsflow requires R >= 4.0.0. ",
"You are using R ", getRversion(), ". ",
"Some features may not work correctly."
)
}
9 changes: 6 additions & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,12 @@ src/*.o
src/*.so
src/*.dll

# If you use renv for package dependency management, ignore these files
renv.lock
renv/
# renv for package dependency management
# Keep renv.lock and renv/activate.R in git for reproducibility
# Ignore the local library and cache
renv/library/
renv/local/
renv/staging/

# If you use packrat for package dependency management, ignore these files
packrat/
Expand Down
9 changes: 4 additions & 5 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,18 @@ Package: chmsflow
Type: Package
Title: Transforming and Harmonizing CHMS Variables
Version: 0.1.0
Author: Rafidul Islam [aut, cre], Douglas Manuel [aut], Therese Chan [aut]
Maintainer: Rafidul Islam <raislam@ohri.ca>
Authors@R: c(
person("Rafidul", "Islam", email = "raislam@ohri.ca", role = c("aut", "cre")),
person("Douglas", "Manuel", email = "dmanuel@ohri.ca", role = c("aut"), comment = c(ORCID = "0000-0003-0912-0845")),
person("Douglas", "Manuel", email = "dmanuel@ohri.ca", role = c("aut"), comment = c(ORCID = "0000-0003-0912-0845")),
person("Therese", "Chan", email = "TChan@bruyere.org", role = c("aut")))
Description: Supporting the use of the Canadian Health Measures Survey (CHMS)
by transforming variables from each cycle into harmonized, consistent
versions that span survey cycles 1-6. This package uses rec_with_table(),
which was developed from 'sjmisc' rec(). Ludecke D (2018). "sjmisc: Data
and Variable Transformation Functions". Journal of Open Source Software,
3(26), 754. <doi:10.21105/joss.00754>.
Depends:
R (>= 3.5)
Depends:
R (>= 4.0)
Imports: dplyr, haven, logger
License: MIT + file LICENSE
URL: https://github.com/Big-Life-Lab/chmsflow, https://big-life-lab.github.io/chmsflow/
Expand All @@ -25,4 +23,5 @@ Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Suggests: DT, kableExtra, knitr, quarto, readr, recodeflow, testthat (>= 3.0.0)
VignetteBuilder: quarto
Config/build/clean-inst-doc: FALSE
LazyData: true
264 changes: 136 additions & 128 deletions R/medications.R
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@ To use `chmsflow` at a Research Data Centre (RDC), you'll need to load the packa
library(chmsflow)
```

## Development setup

This package uses renv for dependency management. After cloning the repository:

```r
# Restore package dependencies
renv::restore()

# Install the package locally
devtools::install()
```

The project requires R >= 4.0.0. When you load the project, `.Rprofile` will warn if your R version is below this floor.

## What's Included?

The `chmsflow` package comes with several useful resources:
Expand Down
Loading
Loading