dipr_document_output_groups: Convenience function to generate templates for documenting...

In bcgov/dipr: Provide functions to efficiently import SRE data

Convenience function to generate templates for documenting export datasets

Description

The usage of this function is to print templated documentation to the console and then copy and paste into the export document create with dipr_use_export_doc. This function works only on csv exports.

Usage

dipr_document_output_groups(path, ...)

Arguments

path

a character vector of full path names; the default corresponds to the working directory, getwd(). Tilde expansion (see path.expand) is performed. Missing values will be ignored. Elements with a marked encoding will be converted to the native encoding (and if that fails, considered non-existent).

...

Arguments passed on to base::list.files pattern an optional regular expression. Only file names which match the regular expression will be returned. all.files a logical value. If FALSE, only the names of visible files are returned (following Unix-style visibility, that is files whose name does not start with a dot). If TRUE, all file names will be returned. full.names a logical value. If TRUE, the directory path is prepended to the file names to give a relative file path. If FALSE, the file names (rather than paths) are returned. recursive logical. Should the listing recurse into directories? ignore.case logical. Should pattern-matching be case-insensitive? include.dirs logical. Should subdirectory names be included in recursive listings? (They always are in non-recursive ones). no.. logical. Should both "." and ".." be excluded also from non-recursive listings?

bcgov/dipr documentation built on June 1, 2022, 12:32 p.m.