use_logger: Setup a Simple Logger for a Package

View source: R/use_logger.R

use_loggerR Documentation

Setup a Simple Logger for a Package

Description

This gives you a minimal logger with no appenders that you can use inside your package under the name lg (e.g. lg$fatal("test")). use_logger() does not modify any files but only prints code for you to copy and paste.

Usage

use_logger(
  pkg = desc::desc_get("Package", rprojroot::find_package_root_file("DESCRIPTION"))[[1]]
)

Arguments

pkg

character scalar. Name of the package. The default is to try to get the Package name automatically using the packages rprojroot and desc

Value

a character scalar containing R code.

Examples

use_logger("testpkg")


lgr documentation built on Sept. 6, 2022, 1:05 a.m.