From ead9e9fd2465b7fdf0d167d6db1ccbab3b0a26ac Mon Sep 17 00:00:00 2001 From: ALanguillaume Date: Mon, 18 Oct 2021 15:16:20 +0200 Subject: [PATCH] Add package level documentation Accessible via `?fusen`. --- R/fusen-package.R | 8 ++++++++ man/fusen-package.Rd | 30 ++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 R/fusen-package.R create mode 100644 man/fusen-package.Rd diff --git a/R/fusen-package.R b/R/fusen-package.R new file mode 100644 index 00000000..b30bbdac --- /dev/null +++ b/R/fusen-package.R @@ -0,0 +1,8 @@ +#' @keywords internal +"_PACKAGE" + +# The following block is used by usethis to automatically manage +# roxygen namespace tags. Modify with care! +## usethis namespace: start +## usethis namespace: end +NULL diff --git a/man/fusen-package.Rd b/man/fusen-package.Rd new file mode 100644 index 00000000..e4a77d39 --- /dev/null +++ b/man/fusen-package.Rd @@ -0,0 +1,30 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/fusen-package.R +\docType{package} +\name{fusen-package} +\alias{fusen} +\alias{fusen-package} +\title{fusen: Build a Package from Rmarkdown File} +\description{ +\if{html}{\figure{logo.png}{options: align='right' alt='logo' width='120'}} + +Use Rmarkdown First method to build your package. Start your package with documentation, functions, examples and tests in the same unique file. Everything can be set from the Rmarkdown template file provided in your project, then inflated as a package. Inflating the template copies the relevant chunks and sections in the appropriate files required for package development. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://thinkr-open.github.io/fusen/} + \item \url{https://github.com/Thinkr-open/fusen} +} + +} +\author{ +\strong{Maintainer}: Sebastien Rochette \email{sebastien@thinkr.fr} (\href{https://orcid.org/0000-0002-1565-9313}{ORCID}) + +Other contributors: +\itemize{ + \item ThinkR [copyright holder] +} + +} +\keyword{internal}