Learn R Programming
Rdpack (version 0.4-4)

compare_usage1: Compare usage entries for a function

Description

Compare usage entries for a function.

Usage

compare_usage1(urdo, ucur)

Arguments

urdo
usage text for a function or S3 method from an Rd object or file.
ucur
usage generated from the actual object.

Value

  • TRUE if the usages are identical, FALSE otherwise. The return value has attribute "details", which is a list providing details of the comparison. The elements of this list should be referred by name, since if one of urdo or ucur is NULL or NA, the list contains only the fields "obj_removed", "obj_added", "rdo_usage", "cur_usage", and "alias".
  • identical_namesa logical value, TRUE if the `name' is the same in both objects.
  • obj_removednames present in urdo but not in ucur
  • obj_addednames present in ucur but not in urdo
  • identical_argnamesa logical value, TRUE if the argument names in both objects are the same.
  • identical_defaultsa logical value, TRUE if the defaults for the arguments in both objects are the same.
  • identical_formalsa logical value, TRUE if the formals are the same, i.e. fields identical_argnames and identical_defaults are both TRUE.
  • added_argnamesnames of arguments in ucur but not in urdo.
  • removed_argnamesnames of arguments in urdo but not in ucur.
  • names_unchanged_defaultsnames of arguments whose defaults are the same.
  • rdo_usagea copy of urdo.
  • cur_usagea copy of ucur.
  • aliasalias of the name of the object, see `Details'.

Details

Compares the usage statements for functions in the Rd object or file urdo to the usage inferred from the actual definitions of the functions. The comparison is symmetric but the interpretation assumes that ucur may be more recent. Note: do not compare the return value to TRUE with identical or isTRUE. The attribute makes the returned value not identical to TRUE in any case.

See Also

inspect_usage