Skip to contents

Bump the copyright year in a file header

Source: R/stamp-update.R
stamp_bump_year.Rd

A convenience wrapper around stamp_update() that extends the header's copyright field to the current year, keeping the owner and start year (see year_extend()).

Usage

stamp_bump_year(file, action = "modify", recursive = FALSE, pattern = NULL)

Arguments

file

Character. Path to a file or directory to update.

action

Character. Action to perform: "modify", "dryrun", or "backup".

recursive

Logical. When file is a directory, descend into subdirectories.

pattern

Character or NULL. When file is a directory, only update files whose name matches this pattern.

Value

TRUE invisibly on success, or a stamp_update_preview object when action = "dryrun".

See also

stamp_update(), stamp_add_author()

Examples

file <- tempfile(fileext = ".R")
writeLines(c("# Copyright (c) 2020", "# Author: Jane", "", "x <- 1"), file)

stamp_bump_year(file)
readLines(file)[1]
#> [1] "# Copyright (c) 2020-2026"