parsetools (version 0.1.1)

pd_is_comment: Is this a comment?

Description

pd_is_comment

Test if an id represents a comment of any kind.

pd_is_relative_comment

Tests if the comment is a relative (location dependent) type comment.

pd_all_relative_comment_ids

Retrieve all ids associated with relative comments.

pd_is_doc_comment

Additionally tests if the comment is a documentation type comment.

Usage

pd_is_comment(id, pd, .check = TRUE)

pd_is_relative_comment(id, pd, .check = TRUE)

pd_all_relative_comment_ids(pd)

pd_is_doc_comment(id, pd, .check = TRUE)

Arguments

id

id of the expression of interest

pd

The parse-data information

.check

Perform checks for input validation?

Value

Should return a logical vector, for parse-data and data.frame should be length of nrow(x). For character same length as x.