Skip to content

Define parameters for plotly() #206

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.

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

Closed
sckott opened this issue Apr 16, 2015 · 4 comments
Closed

Define parameters for plotly() #206

sckott opened this issue Apr 16, 2015 · 4 comments

Comments

@sckott
Copy link
Contributor

sckott commented Apr 16, 2015

Maybe i'm missing something, but could parameters defs be added for the parameters in a call to x$ggplotly() ? eg.. when I look at the function definition,

function (gg = last_plot(), kwargs = list(filename = NULL, fileopt = NULL, 
    width = NULL, height = NULL), session = "interactive") 
...

e.g., gg, kwargs, and session don't seem to be documented

a user commented about this in the guest blog post on our site https://ropensci.org/blog/2014/04/17/plotly/#comment-1971263190

@mkcor
Copy link
Contributor

mkcor commented Apr 28, 2015

@sckott They are not documented in a docstring indeed. There are several examples around the web... But I agree this should be part of the package. How would you go about writing a docstring when the function is a method living under plotly <- function(username=NULL, key=NULL, base_url=NULL) { ... }?

@sckott
Copy link
Contributor Author

sckott commented Apr 28, 2015

hmm, not sure. Though the way you set up the function, R6 seems like a perfect fit . It sounds like there isn't yet, but will be soon support for documenting R6 in roxygen2, eg., see r-lib/roxygen2#306

There are some workaround discussed in the R6 issues here r-lib/R6#3

This was referenced May 2, 2015
@cpsievert cpsievert added this to the v1.0 milestone May 30, 2015
@cpsievert cpsievert mentioned this issue Jun 3, 2015
@cpsievert
Copy link
Collaborator

Fixed as of version 1.0

@sckott
Copy link
Contributor Author

sckott commented Aug 1, 2015

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants