Skip to contents

Add individual USGS project files to a directory

Source: R/use_project_usgs.R
use-file-usgs.Rd

Creates common project files like .gitignore, README.md. LICENSE.md, etc.#'

Usage

use_gitignore_usgs(
  home = ".",
  additions = NULL,
  open = rlang::is_interactive()
)

use_readme_usgs(home = ".", open = rlang::is_interactive())

use_readme_rmd_usgs(home = ".", open = rlang::is_interactive())

use_license_usgs(home = ".", open = rlang::is_interactive())

use_code_json_usgs(home = ".", open = rlang::is_interactive())

use_disclaimer_provisional_usgs(home = ".", open = rlang::is_interactive())

use_disclaimer_approved_usgs(home = ".", open = rlang::is_interactive())

use_code_of_conduct_usgs(home = ".", open = rlang::is_interactive())

use_contributing_usgs(
  home = ".",
  repo_url = NULL,
  open = rlang::is_interactive()
)

use_changelog_usgs(home = ".", open = rlang::is_interactive())

use_gitlab_mr_template_usgs(home = ".", open = FALSE)

Arguments

home

chr, root directory of project. Defaults to current working directory

additions

chr vector, other files/directories to be added to .gitignore

open

lgl; whether to open the file for interactive editing

repo_url

chr, URL to Git repository. If NULL (default) a generic URL will be provided as a link to the repository in CONTRIBUTING.md. Otherwise, the issue page for repo_url will be used as the link.

Examples

if (FALSE) { # \dontrun{
tmp <- tempdir()

use_gitignore_usgs(home = tmp,
                   additions = c("excluded_file.R",
                                 "excluded_dir",
                                 "*excluded_pattern*"))
# here are the contents of the .gitignore:
cat(readLines(file.path(tmp,".gitignore")), sep = "\n")
} # }