Description Usage Arguments Details Value
These functions allow investigation and manipulation of arguments stored on
disk. Stored arguements are used to re-load dpSet
and dpBatch
S3 objects into memory. Under normal use, these fuctions are not necessary;
they were created during development of datapuppy
for troubleshooting
and fixing corrupted dpSets
and dpBatchs
. These functions might
be useful for advanced datapuppy
users. Use with caution. Before
using these functions, fully understand: 1) the structure of the S3 objects;
and 2) how the arguements stored on disk are used to recreate the objects are
stored on disk.
1 2 3 4 5 6 7 8 9 10 11 | dpValidateSetArgNames(set, reportError = TRUE)
dpValidateBatchArgNames(batch, reportError = TRUE)
dpLoadSetArgList(setPath, validate = TRUE)
dpSaveSetArgList(argList, validate = TRUE)
dpLoadBatchArgList(batchPath, validate = TRUE)
dpSaveBatchArgList(argList, batchPath = NULL, validate = TRUE)
|
set |
A |
reportError |
Boolean value when set to |
batch |
A |
setPath |
A character string containing the path to the |
validate |
A boolean determining whether names in the argument list are
validated against |
argList |
A list of arguments used to create a |
batchPath |
A character string containing the path to the |
dpValidateSetArgNames()
(dpValidateBatchArgNames
)
compares the names of the arguments stored on disk in the
dpSet.rData
(dpBatch.rData
) file to the names of
formals(dpSet)
(formals(dpBatch)
) to ensure the
stored argument names are compatible with the constructor functions.
dpLoadSetArgList
(dpLoadBatchArgList
) allow the user to
investigate the list
of stored arguments. dpSaveSetArgList
(dpSaveBatchArgList
) save loaded argument lists
back to
disk, overwriting the original arguments unless a new path is specified in
the argument list. Ideally, these fuctions should not be required by the end
user, but they are provided for troubleshooting purposes or for altering the
attributes of an existing set
(batch
). Use these functions
with care – it would be easy to corrupt a set
(batch
) if you
don't really understand what you are doing.
dpValidateSetArgNames()
(dpValidateBatchArgNames
)
returns a list containing two character vectors. The first vector, named
"missingArguments", contains the names of arguments required by
dpSet()
(dpBatch()
) that are missing from the stored
arguments. The second vector, named "extraArguments" contains the names of
any extra arguments in the stored arguments, which should be removed or
renamed. When reportError
is TRUE, the same information is thrown as
an error and execution is stopped.
dpLoadSetArgList()
returns the list of arguments that was
originally passed to dpSet()
to create the set. By default, the list
will be validated against formals(dpSet)
and an error will be thrown
if the argument list doesn't match. If validate=FALSE, the function will
return the loaded argument list, so that an invalid call list can be
inspected or repaired.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.