Skip to content

Commit c1742df

Browse files
cpsievertcpsievert
committed
update docs
1 parent 481abd9 commit c1742df

18 files changed

+95
-18
lines changed

‎NAMESPACE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Generated by roxygen2 (4.0.2): do not edit by hand
1+
# Generated by roxygen2 (4.1.0): do not edit by hand
22

33
export(gg2list)
44
export(ggplot_build2)

‎man/ensure_file_exist.Rd

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/tools.R
3+
\name{ensure_file_exist}
4+
\alias{ensure_file_exist}
5+
\title{Create file if nonexistent}
6+
\usage{
7+
ensure_file_exist(abspath)
8+
}
9+
\arguments{
10+
\item{abspath}{Character vector of file path}
11+
}
12+
\description{
13+
Create file if nonexistent
14+
}
15+

‎man/get_config_file.Rd

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/tools.R
3+
\name{get_config_file}
4+
\alias{get_config_file}
5+
\title{Read Plotly config file (which is a JSON) and create one if nonexistent}
6+
\usage{
7+
get_config_file(args = c())
8+
}
9+
\arguments{
10+
\item{args}{Character vector of keys you are looking up}
11+
}
12+
\value{
13+
List of keyword-value pairs (config)
14+
}
15+
\description{
16+
Read Plotly config file (which is a JSON) and create one if nonexistent
17+
}
18+
\examples{
19+
\dontrun{
20+
get_config_file(c("plotly_domain", "plotly_streaming_domain"))
21+
}
22+
}
23+

‎man/get_credentials_file.Rd

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/tools.R
3+
\name{get_credentials_file}
4+
\alias{get_credentials_file}
5+
\title{Read Plotly credentials file (which is a JSON)}
6+
\usage{
7+
get_credentials_file(args = c())
8+
}
9+
\arguments{
10+
\item{args}{Character vector of keys you are looking up}
11+
}
12+
\value{
13+
List of keyword-value pairs (credentials)
14+
}
15+
\description{
16+
Read Plotly credentials file (which is a JSON)
17+
}
18+
\examples{
19+
\dontrun{
20+
get_credentials_file(c("username", "api_key"))
21+
}
22+
}
23+

‎man/gg2list.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.2): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/ggplotly.R
23
\name{gg2list}
34
\alias{gg2list}
45
\title{Convert a ggplot to a list.}

‎man/ggplot_build2.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.2): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/build_function.R
23
\name{ggplot_build2}
34
\alias{ggplot_build2}
45
\title{ggplot build function with enhanced return}

‎man/group2NA.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.2): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/trace_generation.R
23
\name{group2NA}
34
\alias{group2NA}
45
\title{Drawing ggplot2 geoms with a group aesthetic is most efficient in

‎man/layer2traces.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.2): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/trace_generation.R
23
\name{layer2traces}
34
\alias{layer2traces}
45
\title{Convert a layer to a list of traces. Called from gg2list()}

‎man/paramORdefault.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.2): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/marker_conversion.R
23
\name{paramORdefault}
34
\alias{paramORdefault}
45
\title{Convert ggplot params to plotly.}

‎man/plotly-package.Rd

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.2): do not edit by hand
1+
% Generated by roxygen2 (4.1.0): do not edit by hand
2+
% Please edit documentation in R/plotly-package.r
23
\docType{package}
34
\name{plotly-package}
45
\alias{plotly-package}
@@ -14,7 +15,7 @@ An example of an interactive graph made from the R API: https://plot.ly/~chris/4
1415
\itemize{
1516
\item Package: plotly
1617
\item Type: Package
17-
\item Version: 0.3.4
18+
\item Version: 0.5.20
1819
\item Date: 2014-03-07
1920
\item License: MIT
2021
}

0 commit comments

Comments
 (0)