summary.parsed_result {defineOptions}

Summarize parsed_result S3 object

Description

summary function for parsed_result S3 object.

Usage

## S3 method for class 'parsed_result'
summary(object,...)

Arguments

object

S3 parsed_result class

...

Further arguments passed to or from other methods.

Details

summary function for parsed_result S3 object. This enables users to see how values are assigned.

Value

List

message

character vector. Description of this list.

assigned values

dataframe holding information about definition name(def_name), option names(long_option or short_option), values and how these values are supplied (opt_specified).

positional arguments

character vector of positional arguments. If there are no positional arguments, NA is assigned.

See Also

parse_with_defs

Examples

# In practice, command line arguments can be obtained by commandArgs() function
# with trailingOnly option TRUE.
# command_arguments = commandArgs(trailingOnly = TRUE)

example_string = "input1.txt input2.txt --target-range 60,140 --exclude-weekend --output log.data"
command_arguments = strsplit( example_string, " ")[[1]]

parsed_result = parse_with_defs(parser_def, command_arguments) # parser_def is a ParserDef object
summary(parsed_result)