Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revise documentation for date format changes #195

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Revise documentation for date format changes #195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions R/addDataFrame.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
#' They need to be specified in Java date format
#' \url{https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html}.
#'
#'Changes to the xlsx date/time formats need to be passed to the R session using the
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#'Changes to the xlsx date/time formats need to be passed to the R session using the
#' Changes to the xlsx date/time formats need to be passed to the R session using the

#'R session function \code{option()} not as an xlsx package parameter.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#'R session function \code{option()} not as an xlsx package parameter.
#' \code{options()} function, not as an xlsx package parameter.

#'
#'An example of this syntax is shown below as a comment.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#'An example of this syntax is shown below as a comment.
#' An example of this syntax is shown below as a comment.

#'
#' @param x a \code{data.frame}.
#' @param sheet a \code{\link{Sheet}} object.
#' @param col.names a logical value indicating if the column names of \code{x}
Expand All @@ -44,6 +49,12 @@
#' @author Adrian Dragulescu
#' @examples
#'
#' # to change the default date format use something like this
#' # options(
#' # xlsx.date.format = 'dd/MM/YYYY',
#' # xlsx.datetime.format = 'dd/MM/YYYY HH:mm:ss'
#' #)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#' #)
#' # )

#'
#'
#' wb <- createWorkbook()
#' sheet <- createSheet(wb, sheetName="addDataFrame1")
Expand All @@ -59,8 +70,6 @@
#' addDataFrame(data, sheet, startRow=3, startColumn=2, colnamesStyle=cs3,
#' rownamesStyle=cs1, colStyle=list(`2`=cs2, `3`=cs2))
#'
#' # to change the default date format use something like this
#' # options(xlsx.date.format="dd MMM, yyyy")
#'
#'
#' # Don't forget to save the workbook ...
Expand Down