Commit 7ce7a88c authored by jml's avatar jml
Browse files

update doc

parent 96e0bf33
...@@ -9,7 +9,7 @@ Description: Basic information from a tbl_friendlyts data.frame. ...@@ -9,7 +9,7 @@ Description: Basic information from a tbl_friendlyts data.frame.
- L-moments. - L-moments.
- Plots. - Plots.
Depends: Depends:
R (>= 3.4.2) R (>= 3.4.1)
Imports: Imports:
tibble, tibble,
dplyr, dplyr,
......
# Generated by roxygen2: do not edit by hand # Generated by roxygen2: do not edit by hand
export(basic_) export(basic_)
export(basic_info) export(basic_info)
export(basic_ts) export(basic_ts)
export(plot_boxwhisk_ts) export(plot_boxwhisk_ts)
export(plot_lmrd) export(plot_lmrd)
export(plot_qq) export(plot_qq)
export(plot_qqRes) export(plot_qqRes)
export(plot_tbl_basic) export(plot_tbl_basic)
export(samlmu2) export(samlmu2)
importFrom(dplyr,"%>%") importFrom(dplyr,"%>%")
importFrom(dplyr,do) importFrom(dplyr,do)
importFrom(dplyr,group_by) importFrom(dplyr,group_by)
importFrom(dplyr,group_by_) importFrom(dplyr,group_by_)
importFrom(dplyr,n) importFrom(dplyr,n)
importFrom(dplyr,summarise) importFrom(dplyr,summarise)
importFrom(dplyr,transmute) importFrom(dplyr,transmute)
importFrom(dplyr,transmute_at) importFrom(dplyr,transmute_at)
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basicr.R % Please edit documentation in R/basicr.R
\name{basic_} \name{basic_}
\alias{basic_} \alias{basic_}
\title{basic_ \title{basic_
basic_} basic_}
\usage{ \usage{
basic_(df, target) basic_(df, target)
} }
\arguments{ \arguments{
\item{df}{tbl_friendlyts object} \item{df}{tbl_friendlyts object}
\item{target}{character} \item{target}{character}
} }
\description{ \description{
basic_ basic_
basic_ basic_
} }
\examples{ \examples{
\dontrun{ \dontrun{
basic_() basic_()
} }
} }
\keyword{basicr} \keyword{basicr}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basicr.R % Please edit documentation in R/basicr.R
\name{basic_info} \name{basic_info}
\alias{basic_info} \alias{basic_info}
\title{basic_info \title{basic_info
basic_info} basic_info}
\usage{ \usage{
basic_info(df, target, group = "none") basic_info(df, target, group = "none")
} }
\arguments{ \arguments{
\item{df}{tbl_friendlyts data.frame} \item{df}{tbl_friendlyts data.frame}
\item{target}{target} \item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several} \item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several}
} }
\description{ \description{
basic_info basic_info
basic_info basic_info
} }
\examples{ \examples{
\dontrun{ \dontrun{
basic_info() basic_info()
} }
} }
\keyword{basicr} \keyword{basicr}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basic_ts.R % Please edit documentation in R/basic_ts.R
\name{basic_ts} \name{basic_ts}
\alias{basic_ts} \alias{basic_ts}
\title{basicr \title{basicr
basicr} basicr}
\usage{ \usage{
basic_ts(df, target, group, precision) basic_ts(df, target, group, precision)
} }
\arguments{ \arguments{
\item{df}{tbl_friendlyts data.frame} \item{df}{tbl_friendlyts data.frame}
\item{target}{target} \item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several} \item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several}
\item{precision}{"daily","hourly","minute","second",...} \item{precision}{"daily","hourly","minute","second",...}
} }
\description{ \description{
basicr basicr
basicr basicr
} }
\examples{ \examples{
\dontrun{ \dontrun{
basicr() basicr()
} }
} }
\keyword{basicr} \keyword{basicr}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lmrd_n_param_distrib.R % Please edit documentation in R/lmrd_n_param_distrib.R
\docType{data} \docType{data}
\name{lmrd_n_param_distrib} \name{lmrd_n_param_distrib}
\alias{lmrd_n_param_distrib} \alias{lmrd_n_param_distrib}
\title{lmrd_n_param_distrib} \title{lmrd_n_param_distrib}
\format{A rda file} \format{A rda file}
\source{ \source{
https://cran.r-project.org/web/packages/lmom/ https://cran.r-project.org/web/packages/lmom/
} }
\description{ \description{
lmrd_n_param_distrib provides L-skewness and L-kurtosis values of key 2-par and 3-par distributions lmrd_n_param_distrib provides L-skewness and L-kurtosis values of key 2-par and 3-par distributions
} }
\references{ \references{
J. R. M. Hosking J. R. M. Hosking
} }
\keyword{basicr} \keyword{basicr}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_boxwhisk_ts.R % Please edit documentation in R/plot_boxwhisk_ts.R
\name{plot_boxwhisk_ts} \name{plot_boxwhisk_ts}
\alias{plot_boxwhisk_ts} \alias{plot_boxwhisk_ts}
\title{plot_boxwhisk_ts \title{plot_boxwhisk_ts
plot_boxwhisk_ts} plot_boxwhisk_ts}
\usage{ \usage{
plot_boxwhisk_ts(x, fromDate = NULL, toDate = NULL, plot_boxwhisk_ts(x, fromDate = NULL, toDate = NULL,
timeResolution = NULL, tzone = "UTC", path = tempdir(), timeResolution = NULL, tzone = "UTC", path = tempdir(),
name = NULL, width_mm = 200, height_mm = 200, y_name = "Y-axis", name = NULL, width_mm = 200, height_mm = 200, y_name = "Y-axis",
DESKTOP = TRUE) DESKTOP = TRUE)
} }
\arguments{ \arguments{
\item{x}{object of class tbl_friendlyts} \item{x}{object of class tbl_friendlyts}
\item{fromDate}{fromDate} \item{fromDate}{fromDate}
\item{toDate}{toDate} \item{toDate}{toDate}
\item{timeResolution}{timeResolution} \item{timeResolution}{timeResolution}
\item{tzone}{tzone} \item{tzone}{tzone}
\item{path}{path} \item{path}{path}
\item{name}{name} \item{name}{name}
\item{width_mm}{width_mm} \item{width_mm}{width_mm}
\item{height_mm}{height_mm} \item{height_mm}{height_mm}
\item{y_name}{name on the y-axis} \item{y_name}{name on the y-axis}
\item{DESKTOP}{boolean} \item{DESKTOP}{boolean}
} }
\description{ \description{
plot_boxwhisk_ts plot_boxwhisk_ts
plot_boxwhisk_ts plot_boxwhisk_ts
} }
\examples{ \examples{
\dontrun{ \dontrun{
plot_boxwhisk_ts() plot_boxwhisk_ts()
} }
} }
\keyword{friendlyts} \keyword{friendlyts}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_lmrd.R % Please edit documentation in R/plot_lmrd.R
\name{plot_lmrd} \name{plot_lmrd}
\alias{plot_lmrd} \alias{plot_lmrd}
\title{plot_lmrd \title{plot_lmrd
plot_lmrd} plot_lmrd}
\usage{ \usage{
plot_lmrd(x, path = tempdir(), name = NULL, DESKTOP = TRUE, plot_lmrd(x, path = tempdir(), name = NULL, DESKTOP = TRUE,
width_mm = 200, height_mm = 200) width_mm = 200, height_mm = 200)
} }
\arguments{ \arguments{
\item{x}{tbl_lmom data.frame} \item{x}{tbl_lmom data.frame}
\item{path}{path} \item{path}{path}
\item{name}{name} \item{name}{name}
\item{DESKTOP}{boolean} \item{DESKTOP}{boolean}
\item{width_mm}{width_mm} \item{width_mm}{width_mm}
\item{height_mm}{height_mm} \item{height_mm}{height_mm}
} }
\description{ \description{
plot_lmrd plot_lmrd
plot_lmrd plot_lmrd
} }
\examples{ \examples{
\dontrun{ \dontrun{
plot_lmrd() plot_lmrd()
} }
} }
\keyword{basicr} \keyword{basicr}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_qq.R % Please edit documentation in R/plot_qq.R
\name{plot_qq} \name{plot_qq}
\alias{plot_qq} \alias{plot_qq}
\title{plot_qq \title{plot_qq
plot_qq} plot_qq}
\usage{ \usage{
plot_qq(x, reference, client, path = tempdir(), name = NULL, plot_qq(x, reference, client, path = tempdir(), name = NULL,
width_mm = 200, height_mm = 200, DESKTOP = TRUE) width_mm = 200, height_mm = 200, DESKTOP = TRUE)
} }
\arguments{ \arguments{
\item{x}{tbl_friendlyts data.frame} \item{x}{tbl_friendlyts data.frame}
\item{reference}{reference in character} \item{reference}{reference in character}
\item{client}{reference in character} \item{client}{reference in character}
\item{path}{path} \item{path}{path}
\item{name}{name} \item{name}{name}
\item{width_mm}{width_mm} \item{width_mm}{width_mm}
\item{height_mm}{height_mm} \item{height_mm}{height_mm}
\item{DESKTOP}{boolean} \item{DESKTOP}{boolean}
} }
\description{ \description{
plot_qq plot_qq
plot_qq plot_qq
} }
\examples{ \examples{
\dontrun{ \dontrun{
plot_qq() plot_qq()
} }
} }
\keyword{basicr} \keyword{basicr}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_qq.R % Please edit documentation in R/plot_qq.R
\name{plot_qqRes} \name{plot_qqRes}
\alias{plot_qqRes} \alias{plot_qqRes}
\title{plot_qqRes \title{plot_qqRes
plot_qqRes} plot_qqRes}
\usage{ \usage{
plot_qqRes(x, reference, client, path = tempdir(), name = NULL, plot_qqRes(x, reference, client, path = tempdir(), name = NULL,
width_mm = 200, height_mm = 200, DESKTOP = TRUE) width_mm = 200, height_mm = 200, DESKTOP = TRUE)
} }
\arguments{ \arguments{
\item{x}{friendlyts data.frame} \item{x}{friendlyts data.frame}
\item{reference}{reference in character} \item{reference}{reference in character}
\item{client}{reference in character} \item{client}{reference in character}
\item{path}{path} \item{path}{path}
\item{name}{name} \item{name}{name}
\item{width_mm}{width_mm} \item{width_mm}{width_mm}
\item{height_mm}{height_mm} \item{height_mm}{height_mm}
\item{DESKTOP}{boolean} \item{DESKTOP}{boolean}
} }
\description{ \description{
plot_qqRes plot_qqRes
plot_qqRes plot_qqRes
} }
\examples{ \examples{
\dontrun{ \dontrun{
plot_qqRes() plot_qqRes()
} }
} }
\keyword{friendlyts} \keyword{friendlyts}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_tbl_basic.R % Please edit documentation in R/plot_tbl_basic.R
\name{plot_tbl_basic} \name{plot_tbl_basic}
\alias{plot_tbl_basic} \alias{plot_tbl_basic}
\title{plot_tbl_basic \title{plot_tbl_basic
plot_tbl_basic} plot_tbl_basic}
\usage{ \usage{
plot_tbl_basic(x, target, group, path = tempdir(), name = NULL, plot_tbl_basic(x, target, group, path = tempdir(), name = NULL,
DESKTOP = TRUE, width_mm = 200, height_mm = 200, DESKTOP = TRUE, width_mm = 200, height_mm = 200,
y_name = "Y-axis") y_name = "Y-axis")
} }
\arguments{ \arguments{
\item{x}{tbl_friendlyts data.frame} \item{x}{tbl_friendlyts data.frame}
\item{target}{target} \item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND"} \item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND"}
\item{path}{path} \item{path}{path}
\item{name}{name} \item{name}{name}
\item{DESKTOP}{boolean} \item{DESKTOP}{boolean}
\item{width_mm}{width_mm} \item{width_mm}{width_mm}
\item{height_mm}{height_mm} \item{height_mm}{height_mm}
\item{y_name}{y_name} \item{y_name}{y_name}
} }
\description{ \description{
plot_tbl_basic plot_tbl_basic
plot_tbl_basic plot_tbl_basic
} }
\examples{ \examples{
\dontrun{ \dontrun{
plot_tbl_basic() plot_tbl_basic()
} }
} }
\keyword{basicr} \keyword{basicr}
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lmom.R % Please edit documentation in R/lmom.R
\name{samlmu2} \name{samlmu2}
\alias{samlmu2} \alias{samlmu2}
\title{samlur \title{samlur
samlur} samlur}
\usage{ \usage{
samlmu2(df, target) samlmu2(df, target)
} }
\arguments{ \arguments{
\item{df}{tbl_friendlyts data.frame} \item{df}{tbl_friendlyts data.frame}
\item{target}{target in character} \item{target}{target in character}
} }
\description{ \description{
samlur samlur
samlur samlur
} }
\examples{ \examples{
\dontrun{ \dontrun{
samlmu2() samlmu2()
} }
} }
\keyword{basicr} \keyword{basicr}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment