# Parse Tools

## Documentation for package ‘parsetools’ version 0.1.3

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A C E F G I L N P R S T V

## -- A --

all_grouping_ids | get the grouping ids
all_root_nodes | Find all root node from parse data
ascend_to_root | Root IDs
assignments | Assignment Node Navigation.
as_parse_data | Parse Data

## -- C --

calls | Call nodes
clean_tag_comments | clean tag comments

## -- E --

end_col | Make a function operate internal to parsetools
end_line | Make a function operate internal to parsetools
expr_text | Make a function operate internal to parsetools
extract_test_block | Extract testing blocks from the parse-data.
extract_test_blocks | extract tests from a file.

## -- F --

family-nodes | Family-wise Node Identification and Navigation.
filename | Make a function operate internal to parsetools
function-nodes | Function Nodes

## -- G --

get_family_pd | Get family of nodes.
get_parse_data | Parse Data
get_parse_data.function | Parse Data
get_parse_data.srcfile | Parse Data
get_parse_data.srcref | Parse Data

## -- I --

ids_ending_on_line | Make a function operate internal to parsetools
ids_starting_on_line | Make a function operate internal to parsetools
if-statements | If Statement Nodes
iff-blocks | IFF Blocks
internal | Make a function operate internal to parsetools
is_first_on_line | Make a function operate internal to parsetools
is_last_on_line | Make a function operate internal to parsetools
is_terminal | Make a function operate internal to parsetools

## -- L --

lines | Make a function operate internal to parsetools

## -- N --

nodes | Make a function operate internal to parsetools
n_children | Count the number of children

## -- P --

parse-data | Parse Data
pd_add_class | Test for Class Definitions
pd_add_class_definition | Test for Class Definitions
pd_all_iff_block_ids | IFF Blocks
pd_all_iff_ids | IFF Blocks
pd_all_relative_comment_ids | Is this a comment?
pd_all_root_ids | Root IDs
pd_all_tagged_iff_block_ids | Find all tagged 'if(FALSE)' blocks.
pd_class_definitions | Test for Class Definitions
pd_end_col | Accessor functions
pd_end_line | Accessor functions
pd_filename | Accessor functions
pd_get_ancestor_ids | Family-wise Node Identification and Navigation.
pd_get_assign_value_id | Assignment Node Navigation.
pd_get_assign_variable_id | Assignment Node Navigation.
pd_get_call_arg_ids | Call nodes
pd_get_call_symbol_id | Call nodes
pd_get_children_ids | Family-wise Node Identification and Navigation.
pd_get_closest_call_id | Get the closest call ID.
pd_get_comment_tag_content | Get the content of a tag
pd_get_firstborn | Family-wise Node Identification and Navigation.
pd_get_function_arg_associated_comment_ids | Function Nodes
pd_get_function_arg_ids | Function Nodes
pd_get_function_arg_variable_ids | Function Nodes
pd_get_function_arg_variable_text | Function Nodes
pd_get_function_body_id | Function Nodes
pd_get_iff_associated_name_id | Find the name that should be associated with an 'if(FALSE)' block.
pd_get_if_alternate_id | If Statement Nodes
pd_get_if_branch_id | If Statement Nodes
pd_get_if_predicate_id | If Statement Nodes
pd_get_next_sibling_id | Family-wise Node Identification and Navigation.
pd_get_parent_id | Family-wise Node Identification and Navigation.
pd_get_prev_sibling_id | Family-wise Node Identification and Navigation.
pd_get_relative_comment_associated_ids | Associate relative documentation comments
pd_get_sibling_ids | Family-wise Node Identification and Navigation.
pd_get_tagged_comment_ids | Get tagged comment ids
pd_has_tag | Check if there is a documentation '@' tag.
pd_identify | Get the ID for an object
pd_identify.default | Get the ID for an object
pd_identify.NULL | Get the ID for an object
pd_identify.srcref | Get the ID for an object
pd_is_assignment | Assignment Node Navigation.
pd_is_call | Call nodes
pd_is_class_definition | Test for Class Definitions
pd_is_comment | Is this a comment?
pd_is_doc_comment | Is this a comment?
pd_is_firstborn | Family-wise Node Identification and Navigation.
pd_is_function | Function Nodes
pd_is_function_arg | Function Nodes
pd_is_grouping | test if an id is a grouping element
pd_is_if | If Statement Nodes
pd_is_iff | IFF Blocks
pd_is_iff_block | IFF Blocks
pd_is_in_class_definition | Test for Class Definitions
pd_is_in_function | Function Nodes
pd_is_relative_comment | Is this a comment?
pd_is_root | Root IDs
pd_is_symbol_call | Call nodes
pd_is_tagged_iff_block | IFF Blocks
pd_make_is_call | Create a function to test if an id is contained in a type
pd_make_is_in_call | Create a function to test if an id is contained in a type
pd_reconstitute | Reconstitute Expressions
pd_start_col | Accessor functions
pd_start_line | Accessor functions
pd_text | Accessor functions
pd_token | Accessor functions
prev_terminal | Make a function operate internal to parsetools

## -- R --

root | Root IDs
root-ids | Root IDs
root-nodes | Root IDs

## -- S --

spans_multiple_lines | Make a function operate internal to parsetools
start_col | Make a function operate internal to parsetools
start_line | Make a function operate internal to parsetools
strip_doc_comment_leads | Remove the characters identifying a documentation comment.
strip_tag | Remove a tag that identified a line.

## -- T --

terminal_ids_on_line | Make a function operate internal to parsetools
text | Make a function operate internal to parsetools
token | Make a function operate internal to parsetools

## -- V --

valid_parse_data | Parse Data