writeCOMMENT: write Code Comments

In RPMG: Graphical User Interface (GUI) for Interactive R Analysis Sessions

write Code Comments

Description

Create a print out of comments for insertion in computer code. Used for separating important blocks of code with helpful, easy to find comments.

Usage

writeCOMMENT(temp, space = " ", letspace = "", MSUB = "0", prefix = "", suffix = "")

Arguments

temp	text string
space	space between words
letspace	space between letters
MSUB	text, substitute character, if this is "ALL", then each letter is substituted. default=NULL
prefix	prefix before the letters
suffix	suffix after the letters

Details

This is a function used for creating comments in computer code. Letters are a fixed height of 7 lines

Value

List	26 letters

Note

Code dumps to the screen, then you must paste in code. If sent in an email, spaces are not preserved. The letters are stored in the routine, these can be changed, but the constant (7 lines) common height should be preserved. Each letter should be one block.

Author(s)

Jonathan M. Lees<[e-mail]>

Examples

 writeCOMMENT("GO TARHEELS", space="      ", letspace = "", MSUB="ALL", prefix="/*" , suffix="*/" )
   writeCOMMENT("START", space="      ", letspace = "", MSUB="ALL", prefix="#######" )
 writeCOMMENT("J M lees", space="      ", letspace = "", MSUB="0" )

 writeCOMMENT("J. M. Lees", space="      ", letspace = "", MSUB="0" )
 writeCOMMENT("J. M. Lees", space="      ", letspace = "", MSUB="." )

writeCOMMENT("J. M. Lees", space="      ", letspace = "" )
writeCOMMENT("J. M. Lees", space="---------", letspace = "" )

writeCOMMENT("J. M. Lees", space="      ", letspace = "", MSUB="ALL" )
writeCOMMENT("J_M_Lees", space="      ", letspace = "", MSUB="ALL" )




  writeCOMMENT("abcdefghi")
writeCOMMENT("jklmnop")

writeCOMMENT("qrstuvwxyz")
writeCOMMENT("1234567890")
writeCOMMENT("WHY?!.-+=_")
writeCOMMENT("2+2=4")
writeCOMMENT("e*exp(pi*i)=-1")

RPMG documentation built on Aug. 19, 2023, 5:12 p.m.