Я использую roxygen2 для создания документации по пакету, который я создал. Документация PDF выглядит хорошо, но когда я бегу help(mypackage) я получаюКак активировать help() с самосозданным пакетом R?
No documentation for ‘mypackage’ in specified packages and libraries:
you could try ‘??mypackage’
Как я могу сделать help(mypackage) работать?
Edit: решение именно то, что @ романо-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 repo? – hrbrmstr
библиотека (mypackage) уже была загружена;) – pachamaltese
@hrbrmstr, когда документация в порядке, это будет общедоступно – pachamaltese