formatPkgTextFile: Get the path to a file within an R package

Description Usage Arguments Value

View source: R/formatText.R

Description

Get the path to a file within an R package

Usage

1
2
3
4
5
6
7
formatPkgTextFile(
  file_name,
  params = NULL,
  dir,
  clean_sql = TRUE,
  package_name = packageName(parent.frame())
)

Arguments

file_name

File name to load from the R package

params

List of Parameter names use to replace variables in the file using str_interp (optional)

dir

The schema name where the data is stored (e.g MRP_OPS)

clean_sql

Should the format of SQL text be cleaned up (e.g. replace newline characters with a space)

package_name

Package name that the file is located in.

Value

Text from the file name provided


PSC-CoTC/AnnualReport documentation built on May 17, 2020, 4:45 a.m.