BinaryFileComparator {verifyr2} | R Documentation |
BinaryFileComparator.R
Description
BinaryFileComparator.R
BinaryFileComparator.R
Details
Fallback comparator for binary files without any specific definied comparator.
Super class
verifyr2::FileComparator
-> BinaryFileComparator
Methods
Public methods
Inherited methods
verifyr2::FileComparator$initialize()
verifyr2::FileComparator$vrf_add_debug()
verifyr2::FileComparator$vrf_add_debug_files()
verifyr2::FileComparator$vrf_close_debug()
verifyr2::FileComparator$vrf_details()
verifyr2::FileComparator$vrf_details_supported()
verifyr2::FileComparator$vrf_open_debug()
verifyr2::FileComparator$vrf_option_value()
verifyr2::FileComparator$vrf_summary()
Method vrf_contents()
Method for getting the single file contents for the comparison. This method returns the file contents in two separate vectors inside a list. The first vector is the file contents and the second one is the file contents with the rows matching the omit string excluded. This method can be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn not be called directly by the user.
Usage
BinaryFileComparator$vrf_contents(file, config, omit)
Arguments
file
file for which to get the contents
config
configuration values
omit
string pattern to omit from the comparison
Method vrf_contents_inner()
Method for getting the inner part for the file contents query. The method returns the file contents in two separate vectors inside a list. The first vector is the file contents and the second one is the file contents with the rows matching the omit string excluded. This method can be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn not be called directly by the user.
Usage
BinaryFileComparator$vrf_contents_inner(contents, config, omit)
Arguments
contents
file contents
config
configuration values
omit
string pattern to omit from the comparison
Method vrf_summary_inner()
Method for comparing the inner part for the details query. The method returns the file contents in two separate vectors inside a list. The first vector is the file contents and the second one is the file contents with the rows matching the omit string excluded. This method can be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn not be called directly by the user.
Usage
BinaryFileComparator$vrf_summary_inner(config, omit)
Arguments
config
configuration values
omit
string pattern to omit from the comparison
Method vrf_details_inner()
Method for comparing the inner part for the details query. This method can be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn't be called directly by the user.
Usage
BinaryFileComparator$vrf_details_inner(config, omit)
Arguments
config
configuration values
omit
string pattern to omit from the comparison
Method clone()
The objects of this class are cloneable with this method.
Usage
BinaryFileComparator$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.
Examples
# The normal way for creating a comparator would be to call the generic
# factory method verifyr2::create_comparator that will automatically create
# the correct comparator instance based on the file types.
file1 <- 'my_file1.bin'
file2 <- 'my_file2.bin'
comparator <- verifyr2::create_comparator(file1, file2)
# If needed, an explicit comparator can be created as well.
file1 <- 'my_file1.bin'
file2 <- 'my_file2.bin'
comparator <- BinaryFileComparator$new(file1, file2)