Commit 93f6b529 authored by QTC.Yulin's avatar QTC.Yulin
Browse files

<fix> fix readme

parent 4d7b4f43
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@
#' @param y a vector of y coordinates
#' @param nbin number of points used to shape the hull, default 100
#' @param nsm number of points used to perform convolution, should less than \code{nbin}, default 10
#' @param addsm number of additional times of revolution performed, default 1
#' @param addsm number of additional times of convolution performed, default 1
#' @param qval quantile of each sector, used to determine the edge of the hull, should less than 1, default 0.95
#' @param sfac expansion size factor, larger value means bigger hull, default 1.5
#'
@@ -100,7 +100,7 @@ polar2cart <- function(r, t, xm, ym) {
#'
#' @param nbin number of points used to shape the hull, default 100
#' @param nsm number of points used to perform convolution, should less than \code{nbin}, default 10
#' @param addsm number of additional times of revolution performed, default 1
#' @param addsm number of additional times of convolution performed, default 1
#' @param qval quantile of each sector, used to determine the edge of the hull, should less than 1, default 0.95
#' @param sfac expansion size factor, larger value means bigger hull, default 1.5
#' @inheritParams ggplot2::layer
+1 −1
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ It has five parameters:

- **nbin**: number of points used to shape the hull, default 100.
- **nsm**: number of points used to perform convolution, should less than **nbin**, default 10.
- **addsm**: number of additional times of revolution performed, default 1.
- **addsm**: number of additional times of convolution performed, default 1.
- **qval**: quantile of each sector, used to determine the edge of the hull, should less than 1, default 0.95.
- **sfac**: expansion size factor, larger value means bigger hull, default 1.5.

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ smoothUnchull(x, y, nbin = 100, nsm = 10, addsm = 1, qval = 0.95,

\item{nsm}{number of points used to perform convolution, should less than \code{nbin}, default 10}

\item{addsm}{number of additional times of revolution performed, default 1}
\item{addsm}{number of additional times of convolution performed, default 1}

\item{qval}{quantile of each sector, used to determine the edge of the hull, should less than 1, default 0.95}

+1 −1
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ the default plot specification, e.g. \code{\link[=borders]{borders()}}.}

\item{nsm}{number of points used to perform convolution, should less than \code{nbin}, default 10}

\item{addsm}{number of additional times of revolution performed, default 1}
\item{addsm}{number of additional times of convolution performed, default 1}

\item{qval}{quantile of each sector, used to determine the edge of the hull, should less than 1, default 0.95}