我使用roxygen2
來構建我創建的包的文檔。 PDF文檔,看起來不錯,但是當我運行help(mypackage)
我得到如何使用自行創建的R包激活help()?
No documentation for ‘mypackage’ in specified packages and libraries:
you could try ‘??mypackage’
我怎樣才能讓help(mypackage)
工作?
編輯:解決的辦法是什麼// @羅馬luštrik下面:-)
我使用roxygen2
來構建我創建的包的文檔。 PDF文檔,看起來不錯,但是當我運行help(mypackage)
我得到如何使用自行創建的R包激活help()?
No documentation for ‘mypackage’ in specified packages and libraries:
you could try ‘??mypackage’
我怎樣才能讓help(mypackage)
工作?
編輯:解決的辦法是什麼// @羅馬luštrik下面:-)
我用一個<package-name>-package.R
文件,其中填充有roxygen2
文檔和代碼一行說:NULL
。
#' Package contains functions used in daily work by our group for ecology at
#' Department of biology, Biotechnical faculty, University of Ljubljana.
#'
#' So far the functions included in the package are:
#' \itemize{
#' \item \code{\link{readClumpp}} Read result of Clumpp into a \code{data.frame}
#' \item \code{\link{writeStructure}} Write a \code{genind} object to be analyzed using Structure
#' \item \code{\link{writeGenePop}} Write a \code{genind} object to be analyzed using GENEPOP
#' \item \code{\link{drawLoci}} Plot alleles using a list of loci
#' }
#'
#' \tabular{ll}{
#' Package: \tab zvau\cr
#' Type: \tab Package\cr
#' Version: \tab 0.2\cr
#' Date: \tab 2015-02-11\cr
#' License: \tab GPL-2\cr
#' LazyData: \tab no\cr
#' }
#'
#' @author Roman Lustrik (\email{[email protected]@emaildomain.com})(\email{[email protected]@gmail.com})
#'
#' Maintainer: Roman Lustrik (\email{[email protected]@emaildomain.com})
#' @name zvau-package
#' @import ggplot2
#' @aliases zvau
#' @docType package
#' @title Misc functions used by out group
#' @keywords package datasets
NULL
當我鍵入?zvau
或help(zvau)
,我得到了R.
爲2以上的文件),也許你不導出您的文檔中的所有「公共」的功能呢?
驚人的!謝謝 昨晚我發現這個:http://stat545.com/packages04_foofactors-package-01.html 它建議相同 – pachamaltese
鏈接到gh/bb/rforge回購? – hrbrmstr
圖書館(mypackage)已經加載;) – pachamaltese
@hrbrmstr當文檔確定時,這將會公開可用 – pachamaltese