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.
- L-moments.
- Plots.
Depends:
R (>= 3.4.2)
R (>= 3.4.1)
Imports:
tibble,
dplyr,
......
# Generated by roxygen2: do not edit by hand
export(basic_)
export(basic_info)
export(basic_ts)
export(plot_boxwhisk_ts)
export(plot_lmrd)
export(plot_qq)
export(plot_qqRes)
export(plot_tbl_basic)
export(samlmu2)
importFrom(dplyr,"%>%")
importFrom(dplyr,do)
importFrom(dplyr,group_by)
importFrom(dplyr,group_by_)
importFrom(dplyr,n)
importFrom(dplyr,summarise)
importFrom(dplyr,transmute)
importFrom(dplyr,transmute_at)
# Generated by roxygen2: do not edit by hand
export(basic_)
export(basic_info)
export(basic_ts)
export(plot_boxwhisk_ts)
export(plot_lmrd)
export(plot_qq)
export(plot_qqRes)
export(plot_tbl_basic)
export(samlmu2)
importFrom(dplyr,"%>%")
importFrom(dplyr,do)
importFrom(dplyr,group_by)
importFrom(dplyr,group_by_)
importFrom(dplyr,n)
importFrom(dplyr,summarise)
importFrom(dplyr,transmute)
importFrom(dplyr,transmute_at)
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basicr.R
\name{basic_}
\alias{basic_}
\title{basic_
basic_}
\usage{
basic_(df, target)
}
\arguments{
\item{df}{tbl_friendlyts object}
\item{target}{character}
}
\description{
basic_
basic_
}
\examples{
\dontrun{
basic_()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basicr.R
\name{basic_}
\alias{basic_}
\title{basic_
basic_}
\usage{
basic_(df, target)
}
\arguments{
\item{df}{tbl_friendlyts object}
\item{target}{character}
}
\description{
basic_
basic_
}
\examples{
\dontrun{
basic_()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basicr.R
\name{basic_info}
\alias{basic_info}
\title{basic_info
basic_info}
\usage{
basic_info(df, target, group = "none")
}
\arguments{
\item{df}{tbl_friendlyts data.frame}
\item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several}
}
\description{
basic_info
basic_info
}
\examples{
\dontrun{
basic_info()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basicr.R
\name{basic_info}
\alias{basic_info}
\title{basic_info
basic_info}
\usage{
basic_info(df, target, group = "none")
}
\arguments{
\item{df}{tbl_friendlyts data.frame}
\item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several}
}
\description{
basic_info
basic_info
}
\examples{
\dontrun{
basic_info()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basic_ts.R
\name{basic_ts}
\alias{basic_ts}
\title{basicr
basicr}
\usage{
basic_ts(df, target, group, precision)
}
\arguments{
\item{df}{tbl_friendlyts data.frame}
\item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several}
\item{precision}{"daily","hourly","minute","second",...}
}
\description{
basicr
basicr
}
\examples{
\dontrun{
basicr()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/basic_ts.R
\name{basic_ts}
\alias{basic_ts}
\title{basicr
basicr}
\usage{
basic_ts(df, target, group, precision)
}
\arguments{
\item{df}{tbl_friendlyts data.frame}
\item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND" or several}
\item{precision}{"daily","hourly","minute","second",...}
}
\description{
basicr
basicr
}
\examples{
\dontrun{
basicr()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lmrd_n_param_distrib.R
\docType{data}
\name{lmrd_n_param_distrib}
\alias{lmrd_n_param_distrib}
\title{lmrd_n_param_distrib}
\format{A rda file}
\source{
https://cran.r-project.org/web/packages/lmom/
}
\description{
lmrd_n_param_distrib provides L-skewness and L-kurtosis values of key 2-par and 3-par distributions
}
\references{
J. R. M. Hosking
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lmrd_n_param_distrib.R
\docType{data}
\name{lmrd_n_param_distrib}
\alias{lmrd_n_param_distrib}
\title{lmrd_n_param_distrib}
\format{A rda file}
\source{
https://cran.r-project.org/web/packages/lmom/
}
\description{
lmrd_n_param_distrib provides L-skewness and L-kurtosis values of key 2-par and 3-par distributions
}
\references{
J. R. M. Hosking
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_boxwhisk_ts.R
\name{plot_boxwhisk_ts}
\alias{plot_boxwhisk_ts}
\title{plot_boxwhisk_ts
plot_boxwhisk_ts}
\usage{
plot_boxwhisk_ts(x, fromDate = NULL, toDate = NULL,
timeResolution = NULL, tzone = "UTC", path = tempdir(),
name = NULL, width_mm = 200, height_mm = 200, y_name = "Y-axis",
DESKTOP = TRUE)
}
\arguments{
\item{x}{object of class tbl_friendlyts}
\item{fromDate}{fromDate}
\item{toDate}{toDate}
\item{timeResolution}{timeResolution}
\item{tzone}{tzone}
\item{path}{path}
\item{name}{name}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{y_name}{name on the y-axis}
\item{DESKTOP}{boolean}
}
\description{
plot_boxwhisk_ts
plot_boxwhisk_ts
}
\examples{
\dontrun{
plot_boxwhisk_ts()
}
}
\keyword{friendlyts}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_boxwhisk_ts.R
\name{plot_boxwhisk_ts}
\alias{plot_boxwhisk_ts}
\title{plot_boxwhisk_ts
plot_boxwhisk_ts}
\usage{
plot_boxwhisk_ts(x, fromDate = NULL, toDate = NULL,
timeResolution = NULL, tzone = "UTC", path = tempdir(),
name = NULL, width_mm = 200, height_mm = 200, y_name = "Y-axis",
DESKTOP = TRUE)
}
\arguments{
\item{x}{object of class tbl_friendlyts}
\item{fromDate}{fromDate}
\item{toDate}{toDate}
\item{timeResolution}{timeResolution}
\item{tzone}{tzone}
\item{path}{path}
\item{name}{name}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{y_name}{name on the y-axis}
\item{DESKTOP}{boolean}
}
\description{
plot_boxwhisk_ts
plot_boxwhisk_ts
}
\examples{
\dontrun{
plot_boxwhisk_ts()
}
}
\keyword{friendlyts}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_lmrd.R
\name{plot_lmrd}
\alias{plot_lmrd}
\title{plot_lmrd
plot_lmrd}
\usage{
plot_lmrd(x, path = tempdir(), name = NULL, DESKTOP = TRUE,
width_mm = 200, height_mm = 200)
}
\arguments{
\item{x}{tbl_lmom data.frame}
\item{path}{path}
\item{name}{name}
\item{DESKTOP}{boolean}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
}
\description{
plot_lmrd
plot_lmrd
}
\examples{
\dontrun{
plot_lmrd()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_lmrd.R
\name{plot_lmrd}
\alias{plot_lmrd}
\title{plot_lmrd
plot_lmrd}
\usage{
plot_lmrd(x, path = tempdir(), name = NULL, DESKTOP = TRUE,
width_mm = 200, height_mm = 200)
}
\arguments{
\item{x}{tbl_lmom data.frame}
\item{path}{path}
\item{name}{name}
\item{DESKTOP}{boolean}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
}
\description{
plot_lmrd
plot_lmrd
}
\examples{
\dontrun{
plot_lmrd()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_qq.R
\name{plot_qq}
\alias{plot_qq}
\title{plot_qq
plot_qq}
\usage{
plot_qq(x, reference, client, path = tempdir(), name = NULL,
width_mm = 200, height_mm = 200, DESKTOP = TRUE)
}
\arguments{
\item{x}{tbl_friendlyts data.frame}
\item{reference}{reference in character}
\item{client}{reference in character}
\item{path}{path}
\item{name}{name}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{DESKTOP}{boolean}
}
\description{
plot_qq
plot_qq
}
\examples{
\dontrun{
plot_qq()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_qq.R
\name{plot_qq}
\alias{plot_qq}
\title{plot_qq
plot_qq}
\usage{
plot_qq(x, reference, client, path = tempdir(), name = NULL,
width_mm = 200, height_mm = 200, DESKTOP = TRUE)
}
\arguments{
\item{x}{tbl_friendlyts data.frame}
\item{reference}{reference in character}
\item{client}{reference in character}
\item{path}{path}
\item{name}{name}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{DESKTOP}{boolean}
}
\description{
plot_qq
plot_qq
}
\examples{
\dontrun{
plot_qq()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_qq.R
\name{plot_qqRes}
\alias{plot_qqRes}
\title{plot_qqRes
plot_qqRes}
\usage{
plot_qqRes(x, reference, client, path = tempdir(), name = NULL,
width_mm = 200, height_mm = 200, DESKTOP = TRUE)
}
\arguments{
\item{x}{friendlyts data.frame}
\item{reference}{reference in character}
\item{client}{reference in character}
\item{path}{path}
\item{name}{name}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{DESKTOP}{boolean}
}
\description{
plot_qqRes
plot_qqRes
}
\examples{
\dontrun{
plot_qqRes()
}
}
\keyword{friendlyts}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_qq.R
\name{plot_qqRes}
\alias{plot_qqRes}
\title{plot_qqRes
plot_qqRes}
\usage{
plot_qqRes(x, reference, client, path = tempdir(), name = NULL,
width_mm = 200, height_mm = 200, DESKTOP = TRUE)
}
\arguments{
\item{x}{friendlyts data.frame}
\item{reference}{reference in character}
\item{client}{reference in character}
\item{path}{path}
\item{name}{name}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{DESKTOP}{boolean}
}
\description{
plot_qqRes
plot_qqRes
}
\examples{
\dontrun{
plot_qqRes()
}
}
\keyword{friendlyts}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_tbl_basic.R
\name{plot_tbl_basic}
\alias{plot_tbl_basic}
\title{plot_tbl_basic
plot_tbl_basic}
\usage{
plot_tbl_basic(x, target, group, path = tempdir(), name = NULL,
DESKTOP = TRUE, width_mm = 200, height_mm = 200,
y_name = "Y-axis")
}
\arguments{
\item{x}{tbl_friendlyts data.frame}
\item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND"}
\item{path}{path}
\item{name}{name}
\item{DESKTOP}{boolean}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{y_name}{y_name}
}
\description{
plot_tbl_basic
plot_tbl_basic
}
\examples{
\dontrun{
plot_tbl_basic()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_tbl_basic.R
\name{plot_tbl_basic}
\alias{plot_tbl_basic}
\title{plot_tbl_basic
plot_tbl_basic}
\usage{
plot_tbl_basic(x, target, group, path = tempdir(), name = NULL,
DESKTOP = TRUE, width_mm = 200, height_mm = 200,
y_name = "Y-axis")
}
\arguments{
\item{x}{tbl_friendlyts data.frame}
\item{target}{target}
\item{group}{"none","YEAR","MONTH","WDAY","HOUR","MINUTE","SECOND"}
\item{path}{path}
\item{name}{name}
\item{DESKTOP}{boolean}
\item{width_mm}{width_mm}
\item{height_mm}{height_mm}
\item{y_name}{y_name}
}
\description{
plot_tbl_basic
plot_tbl_basic
}
\examples{
\dontrun{
plot_tbl_basic()
}
}
\keyword{basicr}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lmom.R
\name{samlmu2}
\alias{samlmu2}
\title{samlur
samlur}
\usage{
samlmu2(df, target)
}
\arguments{
\item{df}{tbl_friendlyts data.frame}
\item{target}{target in character}
}
\description{