在Rd文件中展开示例

时间:2018-02-22 10:06:22

标签: r cran roxygen2 rd

我最近向CRAN提交了一个软件包,其中一条评论是"请解压Rd文件中的所有示例,每个Rd文件可以在不到5秒的时间内执行#34;

我使用roxygen2生成那些rd文件,因此我不能确定通过展开所有示例它们究竟是什么意思。所有人都有一个不要参与的论点,所以我不确定这是否是我要删除的内容。下面是一些示例代码。

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/netDir.R
\name{make.netDir}
\alias{make.netDir}
\title{Directed network}
\usage{
make.netDir(x, disp = FALSE, cap = FALSE, alpha = 0.003, pct = 10,
  carrier = FALSE, metro = FALSE)
}
\arguments{
\item{x}{Data frame}

\item{disp}{Uses the Serrano's disparity filter (\url{https://en.wikipedia.org/wiki/Disparity_filter_algorithm_of_weighted_network})
to extract the backbone of the network.}

\item{cap}{Filters original data based on the edge weight.}

\item{alpha}{Argument for disparity filter.}

\item{pct}{Argument for cap filter. Value should be imput as percentage.}

\item{carrier}{Groups data per carrier and OD}

\item{metro}{Groups data by metropolitan area (not compatible with plot)}
}
\description{
Generates Directed Network with an iGraph object and a Data Frame.
}
\examples{
\dontrun{
make.netDir(OD_sample)

# Apply Disparity Filter
make.netDir(OD_sample, disp = TRUE, alpha = 0.05)

# Apply Percentage Cap
make.netDir(OD_sample, cap = TRUE, pct = 20)
}
}

编辑:包进入CRAN,意味着它通过了所有测试和备注等。但是,我仍然得到了上面提到的评论。

0 个答案:

没有答案