local
parameterA dummy function to be referred by @inheritParams
for a
parameter documentation.
doc_local(local)
Logical, defaulting to FALSE
. If TRUE
, the function will
also create a local copy of the file at the specified path. Note that some
writing functions might not overwrite existing files unless explicitly
allowed. Typically, such functions have a parameter (often named
overwrite
) to control this behavior. Check the documentation of the
writing function used to determine the exact parameter name and pass it
through the ...
argument if necessary. Alternatively, you can define an
anonymous function for fun
that calls a writing function with the
overwriting option enabled.