In ColinFay/dockerfiler: Easy Dockerfile Creation from R

All commands that you use to use when developing packages...

Start using git

usethis::use_git()
# Deal with classical files to ignore
usethis::git_vaccinate()

Set extra sources of documentation

# README
usethis::use_readme_rmd()
# Code of Conduct
usethis::use_code_of_conduct("[e-mail]")
# NEWS
usethis::use_news_md()

From now, you will need to "inflate" your package at least once to be able to use the following commands. Let's go to your flat template, and come back here later if/when needed.

Package development tools

Use once

# Pipe
usethis::use_pipe()

# package-level documentation
usethis::use_package_doc()

# Set CI
# _GitHub
usethis::use_github_action_check_standard()
usethis::use_github_action("pkgdown")
usethis::use_github_action("test-coverage")
# _GitLab
gitlabr::use_gitlab_ci(type = "check-coverage-pkgdown")

# Add new flat template
fusen::add_flat_template("add")

Use everytime needed

# Simulate package installation
pkgload::load_all()

# Generate documentation and deal with dependencies
attachment::att_amend_desc()

# Check the package
pkgload::load_all()
devtools::test() # for interactive required
devtools::check()

Share the package

# set and try pkgdown documentation website
usethis::use_pkgdown()
pkgdown::build_site()

# build the tar.gz to share with others
devtools::build()

Checks for CRAN release ----

Copy the latest version of PREPARE_FOR_CRAN ----

url <- "https://raw.githubusercontent.com/ThinkR-open/prepare-for-cran/master/README.md"
destination <- "dev/dev_history_PREPARE_FOR_CRAN.md"
download.file(url, destfile = destination, mode = "wb")

line <- grep(pattern = "# Prepare for CRAN ----", readLines(destination))
rstudioapi::navigateToFile(destination, line = line)

Run the automated tests

{dockerfiler} specificity : ----

If Check reverse dependencies doesn't workwithrevdep_check()`:

retrieve the GitHub files of the {dockerfiler}-dependent packages (golem),

install attachment locally and check().

BEFORE RELEASE: ----

Add comments for CRAN

Need to .gitignore this file

usethis::use_cran_comments(open = rlang::is_interactive())

Why we have \dontrun{}

usethis::use_git_ignore("cran-comments.md")
usethis::use_git_ignore("CRAN-SUBMISSION")

ColinFay/dockerfiler documentation built on June 12, 2025, 12:02 p.m.