svTools (version 0.9-0)

completeDescription: completion for DESCRIPTION files

Description

Proposes completions for a DESCRIPTION file.

Usage

completeDescription(file, row, column, text = readLines(file), 
    author = getOption("svTools.description.author"))

Arguments

file

a DESCRIPTION file to complete.

row

line in the file where the cursor is located.

column

column in the file where the cursor is located.

text

text to complete.

author

how to complete Author fields. The default value looks for the "svTools.description.author" option.

Value

• A list with the following items:
• ok
  logical indicating if there actually are completions.
• data
  character matrix. The first column gives the completion, the second a description.
• token
  token that is being completed.
• type
  type of results, can be "package", "fields", "other".

concept

completion list for the DESCRIPTION file

References

Writing R extensions defines what should be in a DESCRIPTION file

See Also

lintDescription