Skip to content

Commit

Permalink
Updated documentation to include new doc from PR #71 (76a357b)
Browse files Browse the repository at this point in the history
  • Loading branch information
bwlewis committed Feb 23, 2018
1 parent 72d4ab3 commit 93be547
Show file tree
Hide file tree
Showing 14 changed files with 25 additions and 20 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Expand Up @@ -28,4 +28,4 @@ Imports:
Suggests:
maps
Enhances: knitr, shiny
RoxygenNote: 5.0.1
RoxygenNote: 6.0.1
1 change: 0 additions & 1 deletion man/LeMis.Rd

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

1 change: 0 additions & 1 deletion man/ego.Rd

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

1 change: 0 additions & 1 deletion man/flights.Rd

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

1 change: 0 additions & 1 deletion man/gcol.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/globejs.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/graphjs.Rd

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

1 change: 0 additions & 1 deletion man/lines3d.Rd

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

1 change: 0 additions & 1 deletion man/points3d.Rd

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

25 changes: 20 additions & 5 deletions man/scatterplot3js.Rd

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

1 change: 0 additions & 1 deletion man/texture.Rd

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

3 changes: 1 addition & 2 deletions man/threejs-package.Rd

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

3 changes: 1 addition & 2 deletions man/threejs-shiny.Rd

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

1 change: 0 additions & 1 deletion man/vertices-scatterplotThree-method.Rd

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

2 comments on commit 93be547

@lintr-bot
Copy link

Choose a reason for hiding this comment

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

R/graph.R:191:5: style: Place a space before left parenthesis, except in a function call.

if(! missing(g) && is.list(g) && is.data.frame(g[[1]]) && "edges" %in% names(g))
    ^

R/graph.R:197:5: style: Place a space before left parenthesis, except in a function call.

if(! missing(g) && is.data.frame(g))
    ^

R/graph.R:202:5: style: Place a space before left parenthesis, except in a function call.

if(! missing(layout) && is.data.frame(layout))
    ^

R/graph.R:208:5: style: Place a space before left parenthesis, except in a function call.

if(! is.null(edges))
    ^

R/graph.R:211:7: style: Place a space before left parenthesis, except in a function call.

if(! missing(g) && "color" %in% names(g)) edge.color <- g$color
      ^

R/graph.R:215:5: style: Place a space before left parenthesis, except in a function call.

if(! is.null(nodes))
    ^

R/graph.R:225:5: style: Place a space before left parenthesis, except in a function call.

if(warn_upgrade)
    ^

R/scatterplot.R:19:94: style: Trailing whitespace is superfluous.

#' for the axis with the smallest \code{axis.scale}, and the number of ticks on the remaining 
                                                                                             ^

R/scatterplot.R:20:101: style: Trailing whitespace is superfluous.

#' axes will be increased proportionally to the \code{axis.scale} values. Set to NULL to not display 
                                                                                                    ^

R/scatterplot.R:63:92: style: Trailing whitespace is superfluous.

#' you instead need to maintain the relative distances between points in the original data, 
                                                                                           ^

R/scatterplot.R:228:20: style: Commas should always have a space after.

axis.scale = c(1,1,1),
                   ^

R/scatterplot.R:228:22: style: Commas should always have a space after.

axis.scale = c(1,1,1),
                     ^

R/scatterplot.R:255:5: style: Place a space before left parenthesis, except in a function call.

if(renderer == "canvas")
    ^

R/scatterplot.R:274:1: style: Trailing whitespace is superfluous.

^~

R/scatterplot.R:303:5: style: Place a space before left parenthesis, except in a function call.

if(any(is.na(axis.scale))) {
    ^

R/scatterplot.R:306:7: style: Place a space before left parenthesis, except in a function call.

if(length(axis.scale)!=3) {
      ^

R/scatterplot.R:310:34: style: Commas should always have a space after.

axis.scale <- axis.scale[c(1,3,2)]
                                 ^

R/scatterplot.R:310:36: style: Commas should always have a space after.

axis.scale <- axis.scale[c(1,3,2)]
                                   ^

R/scatterplot.R:315:30: style: Remove spaces before the left parenthesis in a function call.

x <- lapply(x, function(x) ((x[, 1:3, drop=FALSE] - rep(mn, each = n)) / rep((mx - mn)/axis.scale, each = n)))
                             ^

R/scatterplot.R:315:31: style: Place a space before left parenthesis, except in a function call.

x <- lapply(x, function(x) ((x[, 1:3, drop=FALSE] - rep(mn, each = n)) / rep((mx - mn)/axis.scale, each = n)))
                              ^

R/scatterplot.R:315:80: style: Place a space before left parenthesis, except in a function call.

x <- lapply(x, function(x) ((x[, 1:3, drop=FALSE] - rep(mn, each = n)) / rep((mx - mn)/axis.scale, each = n)))
                                                                               ^

R/scatterplot.R:342:9: style: Place a space before left parenthesis, except in a function call.

if(length(num.ticks) != 1) {
        ^

R/scatterplot.R:345:32: style: Commas should always have a space after.

num.ticks <- round(max(1,num.ticks) * axis.scale)
                               ^

R/scatterplot.R:380:1: style: Trailing whitespace is superfluous.

^~

R/scatterplot.R:383:1: style: Trailing whitespace is superfluous.

^~

R/scatterplot.R:422:29: style: Use <-, not =, for assignment.

​    names(options$vertices) = NULL
                            ^

R/scatterplot.R:423:26: style: Use <-, not =, for assignment.

​    names(options$color) = NULL
                         ^

R/scatterplot.R:424:26: style: Use <-, not =, for assignment.

​    names(options$alpha) = NULL
                         ^

R/scatterplot.R:425:25: style: Use <-, not =, for assignment.

​    names(options$from) = NULL
                        ^

R/scatterplot.R:426:23: style: Use <-, not =, for assignment.

​    names(options$to) = NULL
                      ^

R/scatterplot.R:427:25: style: Use <-, not =, for assignment.

​    names(options$main) = NULL
                        ^

R/scatterplot.R:441:7: style: Place a space before left parenthesis, except in a function call.

if(!is.null(options$from))
      ^

R/scatterplot.R:511:3: style: Trailing whitespace is superfluous.

#' 
  ^

R/scatterplot.R:636:7: style: Place a space before left parenthesis, except in a function call.

if(is.list(options$from[[N]])) options$from[[N]] <- c(unlist(options$from[[N]]), unlist(from))
      ^

R/scatterplot.R:638:7: style: Place a space before left parenthesis, except in a function call.

if(is.list(options$to[[N]])) options$to[[N]] <- c(unlist(options$to[[N]]), unlist(to))
      ^

@lintr-bot
Copy link

Choose a reason for hiding this comment

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

R/graph.R:191:5: style: Place a space before left parenthesis, except in a function call.

if(! missing(g) && is.list(g) && is.data.frame(g[[1]]) && "edges" %in% names(g))
    ^

R/graph.R:197:5: style: Place a space before left parenthesis, except in a function call.

if(! missing(g) && is.data.frame(g))
    ^

R/graph.R:202:5: style: Place a space before left parenthesis, except in a function call.

if(! missing(layout) && is.data.frame(layout))
    ^

R/graph.R:208:5: style: Place a space before left parenthesis, except in a function call.

if(! is.null(edges))
    ^

R/graph.R:211:7: style: Place a space before left parenthesis, except in a function call.

if(! missing(g) && "color" %in% names(g)) edge.color <- g$color
      ^

R/graph.R:215:5: style: Place a space before left parenthesis, except in a function call.

if(! is.null(nodes))
    ^

R/graph.R:225:5: style: Place a space before left parenthesis, except in a function call.

if(warn_upgrade)
    ^

R/scatterplot.R:19:94: style: Trailing whitespace is superfluous.

#' for the axis with the smallest \code{axis.scale}, and the number of ticks on the remaining 
                                                                                             ^

R/scatterplot.R:20:101: style: Trailing whitespace is superfluous.

#' axes will be increased proportionally to the \code{axis.scale} values. Set to NULL to not display 
                                                                                                    ^

R/scatterplot.R:63:92: style: Trailing whitespace is superfluous.

#' you instead need to maintain the relative distances between points in the original data, 
                                                                                           ^

R/scatterplot.R:228:20: style: Commas should always have a space after.

axis.scale = c(1,1,1),
                   ^

R/scatterplot.R:228:22: style: Commas should always have a space after.

axis.scale = c(1,1,1),
                     ^

R/scatterplot.R:255:5: style: Place a space before left parenthesis, except in a function call.

if(renderer == "canvas")
    ^

R/scatterplot.R:274:1: style: Trailing whitespace is superfluous.

^~

R/scatterplot.R:303:5: style: Place a space before left parenthesis, except in a function call.

if(any(is.na(axis.scale))) {
    ^

R/scatterplot.R:306:7: style: Place a space before left parenthesis, except in a function call.

if(length(axis.scale)!=3) {
      ^

R/scatterplot.R:310:34: style: Commas should always have a space after.

axis.scale <- axis.scale[c(1,3,2)]
                                 ^

R/scatterplot.R:310:36: style: Commas should always have a space after.

axis.scale <- axis.scale[c(1,3,2)]
                                   ^

R/scatterplot.R:315:30: style: Remove spaces before the left parenthesis in a function call.

x <- lapply(x, function(x) ((x[, 1:3, drop=FALSE] - rep(mn, each = n)) / rep((mx - mn)/axis.scale, each = n)))
                             ^

R/scatterplot.R:315:31: style: Place a space before left parenthesis, except in a function call.

x <- lapply(x, function(x) ((x[, 1:3, drop=FALSE] - rep(mn, each = n)) / rep((mx - mn)/axis.scale, each = n)))
                              ^

R/scatterplot.R:315:80: style: Place a space before left parenthesis, except in a function call.

x <- lapply(x, function(x) ((x[, 1:3, drop=FALSE] - rep(mn, each = n)) / rep((mx - mn)/axis.scale, each = n)))
                                                                               ^

R/scatterplot.R:342:9: style: Place a space before left parenthesis, except in a function call.

if(length(num.ticks) != 1) {
        ^

R/scatterplot.R:345:32: style: Commas should always have a space after.

num.ticks <- round(max(1,num.ticks) * axis.scale)
                               ^

R/scatterplot.R:380:1: style: Trailing whitespace is superfluous.

^~

R/scatterplot.R:383:1: style: Trailing whitespace is superfluous.

^~

R/scatterplot.R:422:29: style: Use <-, not =, for assignment.

​    names(options$vertices) = NULL
                            ^

R/scatterplot.R:423:26: style: Use <-, not =, for assignment.

​    names(options$color) = NULL
                         ^

R/scatterplot.R:424:26: style: Use <-, not =, for assignment.

​    names(options$alpha) = NULL
                         ^

R/scatterplot.R:425:25: style: Use <-, not =, for assignment.

​    names(options$from) = NULL
                        ^

R/scatterplot.R:426:23: style: Use <-, not =, for assignment.

​    names(options$to) = NULL
                      ^

R/scatterplot.R:427:25: style: Use <-, not =, for assignment.

​    names(options$main) = NULL
                        ^

R/scatterplot.R:441:7: style: Place a space before left parenthesis, except in a function call.

if(!is.null(options$from))
      ^

R/scatterplot.R:511:3: style: Trailing whitespace is superfluous.

#' 
  ^

R/scatterplot.R:636:7: style: Place a space before left parenthesis, except in a function call.

if(is.list(options$from[[N]])) options$from[[N]] <- c(unlist(options$from[[N]]), unlist(from))
      ^

R/scatterplot.R:638:7: style: Place a space before left parenthesis, except in a function call.

if(is.list(options$to[[N]])) options$to[[N]] <- c(unlist(options$to[[N]]), unlist(to))
      ^

Please sign in to comment.