Skip to content

Commit

Permalink
use md in manuals
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgohel committed Jun 25, 2019
1 parent 847c8a2 commit fb82a92
Show file tree
Hide file tree
Showing 12 changed files with 83 additions and 89 deletions.
63 changes: 31 additions & 32 deletions R/axis_setting.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,45 +20,44 @@
#' @param position position value that cross the other axis.
#' @param second_axis unused
#' @section num_fmt:
#' All \code{\%} need to be doubled, \code{0\%\%} mean "a number
#' All `\%` need to be doubled, `0\%\%` mean "a number
#' and percent symbol".
#'
#' From my actual knowledge, depending on some chart type
#' and options, the following values are not systematically
#' used by office chart engine; i.e. when chart pre-compute
#' percentages, it seems using \code{0\%\%} will have no
#' percentages, it seems using `0\%\%` will have no
#' effect.
#'
#' \itemize{
#' \item General: default value
#' \item 0: display the number with no decimal
#' \item 0.00: display the number with two decimals
#' \item 0\%\%: display as percentages
#' \item 0.00\%\%: display as percentages with two digits
#' \item #,##0
#' \item #,##0.00
#' \item 0.00E+00
#' \item # ?/?
#' \item # ??/??
#' \item mm-dd-yy
#' \item d-mmm-yy
#' \item d-mmm
#' \item mmm-yy
#' \item h:mm AM/PM
#' \item h:mm:ss AM/PM
#' \item h:mm
#' \item h:mm:ss
#' \item m/d/yy h:mm
#' \item #,##0 ;(#,##0)
#' \item #,##0 ;[Red](#,##0)
#' \item #,##0.00;(#,##0.00)
#' \item #,##0.00;[Red](#,##0.00)
#' \item mm:ss
#' \item [h]:mm:ss
#' \item mmss.0
#' \item ##0.0E+0
#' \item @
#' }
#' * `General`: default value
#' * `0`: display the number with no decimal
#' * `0.00`: display the number with two decimals
#' * `0\%\%`: display as percentages
#' * `0.00\%\%`: display as percentages with two digits
#' * `#,##0`
#' * `#,##0.00`
#' * `0.00E+00`
#' * `# ?/?`
#' * `# ??/??`
#' * `mm-dd-yy`
#' * `d-mmm-yy`
#' * `d-mmm`
#' * `mmm-yy`
#' * `h:mm AM/PM`
#' * `h:mm:ss AM/PM`
#' * `h:mm`
#' * `h:mm:ss`
#' * `m/d/yy h:mm`
#' * `#,##0 ;(#,##0)`
#' * `#,##0 ;[Red](#,##0)`
#' * `#,##0.00;(#,##0.00)`
#' * `#,##0.00;[Red](#,##0.00)`
#' * `mm:ss`
#' * `[h]:mm:ss`
#' * `mmss.0`
#' * `##0.0E+0`
#' * `@`
#'
#' @export
chart_ax_x <- function( x, orientation, crosses, cross_between,
major_tick_mark, minor_tick_mark,
Expand Down
16 changes: 6 additions & 10 deletions R/mschart.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@ NULL
#'
#' A dataset containing 2 categorical and an integer variables:
#'
#' \itemize{
#' \item browser web browser
#' \item serie id of series
#' \item value integer values
#' }
#' * browser web browser
#' * serie id of series
#' * value integer values
#'
#' @name browser_data
#' @docType data
Expand All @@ -30,11 +28,9 @@ NULL
#'
#' A dataset containing a date, a categorical and an integer variables:
#'
#' \itemize{
#' \item date date values
#' \item browser web browser
#' \item freq values in percent
#' }
#' * date date values
#' * browser web browser
#' * freq values in percent
#'
#' @name browser_ts
#' @docType data
Expand Down
6 changes: 3 additions & 3 deletions man/browser_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/browser_ts.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

65 changes: 32 additions & 33 deletions man/chart_ax_x.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/chart_data_fill.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/chart_data_labels.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/chart_data_line_width.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/chart_data_size.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/chart_data_smooth.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/chart_data_stroke.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/chart_data_symbol.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fb82a92

Please sign in to comment.