Test functions and documentation etc

Author: IanPRoberts

.Rbuildignore

@@ -1 +1,3 @@
 ^\.github$
+^.*\.Rproj$
+^\.Rproj\.user$

DESCRIPTION

@@ -0,0 +1,10 @@
+Package: TestPackage
+Type: Package
+Title: What the Package Does (Short Line)
+Version: 1.0
+Date: 2025-10-21
+Author: Who wrote it
+Maintainer: Who to complain to <yourfault@somewhere.net>
+Description: More about what it does (maybe more than one line).
+License: What license is it under?
+RoxygenNote: 7.3.3

NAMESPACE

@@ -0,0 +1,3 @@
+# Generated by roxygen2: do not edit by hand
+
+export(f)

R/f.R

@@ -0,0 +1,11 @@
+#' Test function
+#' 
+#' @param x Test input
+#'
+#' @return Not much
+#' 
+#' @export
+f <-
+function( x ){
+  print( x^2 )
+}

man/TestPackage-package.Rd

@@ -0,0 +1,35 @@
+\name{TestPackage-package}
+\alias{TestPackage-package}
+\alias{TestPackage}
+\docType{package}
+\title{
+\packageTitle{TestPackage}
+}
+\description{
+\packageDescription{TestPackage}
+}
+\details{
+%%  ~~ An overview of how to use the package, ~~
+%%  ~~ including the most important functions ~~
+}
+\author{
+\packageAuthor{TestPackage}
+
+Maintainer: \packageMaintainer{TestPackage}
+}
+\references{
+%%  ~~ Literature or other references for background information ~~
+}
+\keyword{package}
+
+%% Uncomment below to imitate parts of library(help = TestPackage)
+%\section{The \file{DESCRIPTION} File}{\packageDESCRIPTION{TestPackage}}
+%\section{Documentation Index}{\packageIndices{TestPackage}}
+
+\seealso{
+%%  ~~ Optional links to other man pages, e.g. ~~
+%%  ~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~
+}
+\examples{
+%%  ~~ Optional simple examples of the most important functions ~~
+}

man/f.Rd

@@ -0,0 +1,12 @@
+# This file is part of the standard setup for testthat.
+# It is recommended that you do not modify it.
+#
+# Where should you do additional test configuration?
+# Learn more about the roles of various files in:
+# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview
+# * https://testthat.r-lib.org/articles/special-files.html
+
+library(testthat)
+library(TestPackage)
+
+test_check("TestPackage")

tests/testthat.R

@@ -0,0 +1,3 @@
+test_that("test_test", {
+  expect_equal( f( 2 ), 4)
+})