[x] Please add \value to .Rd files regarding exported methods and explain
the functions results in the documentation.
Please write about the
structure of the output (class) and also what the output means. (If a
function does not return a value, please document that too, e.g.
\value{No return value, called for side effects} or similar)
Missing Rd-tags:
attachment-deprecated.Rd: \value
=> Added in the meta description of attachment-deprecated
#' @keywords internal
#' @return List of functions used for deprecation side effects.
#' Output depends on the deprecated function.
[x] Please always write package names, software names and API (application
programming interface) names in single quotes in title and description.
e.g: --> 'R'
Please note that package names are case sensitive.
=> Corrected R to ".R" in the description as I speak about the extension and not the software.
Similarly corrected Rmd to ".Rmd"
[x] Please omit the redundant "Tools to help" at the start of your description.
=> Changed to: Manage dependencies during package development.
[x] You are using installed.packages() in your code. As mentioned in the
notes of installed.packages() help page, this can be very slow.
Therefore do not use installed.packages(). -> man/find_remotes.Rd
=> The example where it appeared was changed to: find_remotes(list.files(.libPaths())).
Hence, we only retrieve installed packages names, and not all the extra information not needed
for this example.
"This needs to read several files per installed package, which will be
slow on Windows and on some network-mounted file systems. It will be
slow when thousands of packages are installed, so do not use it to find
out if a named package is installed (use find.package or system.file)
nor to find out if a package is usable (call requireNamespace or require
and check the return value) nor to find details of a small number of
packages (use packageDescription)." [installed.packages() help page]
statnmap
commented
2 years ago
=> Added in the meta description of
attachment-deprecated=> Corrected R to ".R" in the description as I speak about the extension and not the software. Similarly corrected Rmd to ".Rmd"
=> Changed to: Manage dependencies during package development.
=> The example where it appeared was changed to:
find_remotes(list.files(.libPaths())). Hence, we only retrieve installed packages names, and not all the extra information not needed for this example.