forked from JanMarvin/openxlsx2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wb_comment.Rd
35 lines (30 loc) · 955 Bytes
/
wb_comment.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/class-comment.R
\name{wb_comment}
\alias{wb_comment}
\title{Create a comment object}
\usage{
wb_comment(
text = NULL,
style = NULL,
visible = FALSE,
author = getOption("openxlsx2.creator"),
width = 2,
height = 4
)
}
\arguments{
\item{text}{Comment text. Character vector.}
\item{style}{A Style object or list of style objects the same length as comment vector.}
\item{visible}{Is comment visible? Default: \code{FALSE}.}
\item{author}{Author of comment. A string. By default, will look at \code{options("openxlsx2.creator")}.
Otherwise, will check the system username.}
\item{width}{Textbox integer width in number of cells}
\item{height}{Textbox integer height in number of cells}
}
\value{
A \code{wbComment} object
}
\description{
Creates a \code{wbComment} object. Use with \code{\link[=wb_add_comment]{wb_add_comment()}} to add to a worksheet location.
}