Skip to content

Commit

Permalink
roxygenize
Browse files Browse the repository at this point in the history
  • Loading branch information
timelyportfolio committed Dec 18, 2015
1 parent 385274d commit 8a4f3ae
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 19 deletions.
9 changes: 5 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: parcoords
Title: htmlwidget for d3.js parallel coordinates chart
Version: 0.2
Version: 0.2.1
Authors@R: c( person("Mike", "Bostock", role = c("aut", "cph"), comment =
"d3.js library in htmlwidgets/lib, http://d3js.org"), person("Kai", "Chang"
,role = c( "aut","cph" ), comment = "parallel coordinates reusable chart,
Expand All @@ -10,9 +10,9 @@ Authors@R: c( person("Mike", "Bostock", role = c("aut", "cph"), comment =
person("Mark","Albrecht",role = c("ctb"),comment = "Shiny output and example",
email="[email protected]"))
Maintainer: Kenton Russell <[email protected]>
Description: Create interactive parallel coordinates charts with this
htmlwidget wrapper for d3.js
\href{http://syntagmatic.github.io/parallel-coordinates/}{parallel-coordinates}.
Description: Create interactive parallel coordinates charts with this htmlwidget
wrapper for d3.js \href{http://syntagmatic.github.io/parallel-coordinates/}
{parallel-coordinates}.
Depends:
R (>= 3.1.2)
License: MIT + file LICENSE
Expand All @@ -23,3 +23,4 @@ Suggests:
knitr,
testthat
VignetteBuilder: knitr
RoxygenNote: 4.1.1.9001
2 changes: 1 addition & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Generated by roxygen2 (4.1.0): do not edit by hand
# Generated by roxygen2: do not edit by hand

export(parcoords)
export(parcoordsOutput)
Expand Down
6 changes: 3 additions & 3 deletions R/parcoords.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#' this parameter, we will append rownames to the data that we send to JavaScript.
#' If \code{rownames} equals \code{FALSE}, then we will use parallel coordinates
#' to hide it.
#' @param color see \href{https://github.com/syntagmatic/parallel-coordinates#parcoords_color}{parcoords.color( color )}.
#' @param color see \href{https://github.com/syntagmatic/parallel-coordinates\#parcoords_color}{parcoords.color( color )}.
#' Color can be a single color as rgb or hex. For a color function,
#' provide a list( colorScale = , colorBy = ) where colorScale is
#' a function such as \code{d3.scale.category10()} and colorBy
Expand All @@ -25,13 +25,13 @@
#' this will change automatically and might result in unexpected
#' behavior.
#' @param composite foreground context's composite type
#' see \href{https://github.com/syntagmatic/parallel-coordinates#parcoords_composite}{parcoords.composite}
#' see \href{https://github.com/syntagmatic/parallel-coordinates\#parcoords_composite}{parcoords.composite}
#' @param alpha opacity from 0 to 1 of the polylines
#' @param queue logical (default FALSE) to change rendering mode to queue for
#' progressive rendering. Usually \code{ queue = T } for very large datasets.
#' @param mode string see\code{queue} above; \code{ queue = T } will set
#' \code{ mode = "queue" }
#' @param rate integer rate at which render will queue; see \href{https://github.com/syntagmatic/parallel-coordinates#parcoords_rate}{}
#' @param rate integer rate at which render will queue; see \href{https://github.com/syntagmatic/parallel-coordinates\#parcoords_rate}{}
#' for a full discussion and some recommendations
#' @param tasks a character string or \code{\link[htmlwidgets]{JS}} or list of
#' strings or \code{JS} representing a JavaScript function(s) to run
Expand Down
12 changes: 3 additions & 9 deletions man/parcoords.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/parcoordsOutput.Rd

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

3 changes: 2 additions & 1 deletion man/renderParcoords.Rd

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

0 comments on commit 8a4f3ae

Please sign in to comment.