From fa2e02484e10913ef555071f54ebee10816308be Mon Sep 17 00:00:00 2001 From: robinlovelace Date: Tue, 30 Apr 2024 22:09:45 +0100 Subject: [PATCH] Document --- DESCRIPTION | 13 +++++-------- man/style_dir.Rd | 11 ++++++----- man/style_pkg.Rd | 11 ++++++----- 3 files changed, 17 insertions(+), 18 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b39759c..a4c6181 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,15 +2,12 @@ Package: styler.equals Title: Third-Party 'Equals Style' Guide for 'styler' Version: 1.0.0 Authors@R: c( - person("Robin", "Lovelace", email = "rob00x@gmail.com", role = c("aut","cre"), - comment = c(ORCID = "0000-0001-5679-6536")), - person(given = "Lorenz", - family = "Walthert", - role = c("aut")) + person("Robin", "Lovelace", , "rob00x@gmail.com", role = c("aut", "cre"), + comment = c(ORCID = "0000-0001-5679-6536")), + person("Lorenz", "Walthert", role = "aut") ) -Description: Styles code according to the 'equals style' - used in the book Geocomputation with R using - 'styler'. +Description: Styles code according to the 'equals style' used in the book + Geocomputation with R using 'styler'. License: MIT + file LICENSE Imports: purrr, diff --git a/man/style_dir.Rd b/man/style_dir.Rd index b53d873..b04ee46 100644 --- a/man/style_dir.Rd +++ b/man/style_dir.Rd @@ -34,15 +34,16 @@ conveniently constructed via the \code{style} argument and \code{...}. See 'Examples'.} \item{filetype}{Vector of file extensions indicating which file types should -be styled. Case is ignored, and the \code{.} is optional, e.g. \code{c(".R", ".Rmd")}, or \code{c("r", "rmd")}. Supported values (after standardization) are: -"r", "rprofile", "rmd", "rmarkdown", "rnw", "qmd". Rmarkdown is treated as -Rmd.} +be styled. Case is ignored, and the \code{.} is optional, e.g. \code{c(".R",".Rmd")}, +or \code{c("r", "rmd")}. Supported values (after standardization) are: +"qmd", "r", "rmd", "rmarkdown", "rnw", and "rprofile". +Rmarkdown is treated as Rmd.} \item{recursive}{A logical value indicating whether or not files in sub directories of \code{path} should be styled as well.} -\item{exclude_files}{Character vector with paths to files that should be -excluded from styling.} +\item{exclude_files}{Character vector with regular expressions to files +that should be excluded from styling.} \item{exclude_dirs}{Character vector with directories to exclude (recursively).} diff --git a/man/style_pkg.Rd b/man/style_pkg.Rd index eee5522..0e424ac 100644 --- a/man/style_pkg.Rd +++ b/man/style_pkg.Rd @@ -33,12 +33,13 @@ conveniently constructed via the \code{style} argument and \code{...}. See 'Examples'.} \item{filetype}{Vector of file extensions indicating which file types should -be styled. Case is ignored, and the \code{.} is optional, e.g. \code{c(".R", ".Rmd")}, or \code{c("r", "rmd")}. Supported values (after standardization) are: -"r", "rprofile", "rmd", "rmarkdown", "rnw", "qmd". Rmarkdown is treated as -Rmd.} +be styled. Case is ignored, and the \code{.} is optional, e.g. \code{c(".R",".Rmd")}, +or \code{c("r", "rmd")}. Supported values (after standardization) are: +"qmd", "r", "rmd", "rmarkdown", "rnw", and "rprofile". +Rmarkdown is treated as Rmd.} -\item{exclude_files}{Character vector with paths to files that should be -excluded from styling.} +\item{exclude_files}{Character vector with regular expressions to files +that should be excluded from styling.} \item{exclude_dirs}{Character vector with directories to exclude (recursively). Note that the default values were set for consistency with