Polish documentation and Makefile

The Makefile was adjusted to the way used in other packages
of mine. Note that, @inheritParams does not work for
superclasses yet, see https://github.com/r-lib/roxygen2/issues/996,
so some function parameters are documented twice.

3 files changed, 107 insertions, 0 deletions

diff --git a/log/build.log b/log/build.log
new file mode 100644
index 0000000..b6e3ba5
--- /dev/null
+++ b/log/build.log
@@ -0,0 +1,8 @@
+* checking for file ‘./DESCRIPTION’ ... OK
+* preparing ‘chents’:
+* checking DESCRIPTION meta-information ... OK
+* checking for LF line-endings in source and make files and shell scripts
+* checking for empty or unneeded directories
+Omitted ‘LazyData’ from DESCRIPTION
+* building ‘chents_0.3.7.tar.gz’
+
diff --git a/log/check.log b/log/check.log
new file mode 100644
index 0000000..95a06de
--- /dev/null
+++ b/log/check.log
@@ -0,0 +1,73 @@
+* using log directory ‘/home/agsad.admin.ch/f80868656/projects/chents/chents.Rcheck’
+* using R version 4.4.1 (2024-06-14)
+* using platform: x86_64-pc-linux-gnu
+* R was compiled by
+    gcc (Ubuntu 11.4.0-1ubuntu1~22.04) 11.4.0
+    GNU Fortran (Ubuntu 11.4.0-1ubuntu1~22.04) 11.4.0
+* running under: Ubuntu 22.04.5 LTS
+* using session charset: UTF-8
+* using options ‘--no-tests --as-cran’
+* checking for file ‘chents/DESCRIPTION’ ... OK
+* checking extension type ... Package
+* this is package ‘chents’ version ‘0.3.7’
+* package encoding: UTF-8
+* checking CRAN incoming feasibility ... Note_to_CRAN_maintainers
+Maintainer: ‘Johannes Ranke <johannes.ranke@jrwb.de>’
+* checking package namespace information ... OK
+* checking package dependencies ... OK
+* checking if this is a source package ... OK
+* checking if there is a namespace ... OK
+* checking for executable files ... OK
+* checking for hidden files and directories ... OK
+* checking for portable file names ... OK
+* checking for sufficient/correct file permissions ... OK
+* checking serialization versions ... OK
+* checking whether package ‘chents’ can be installed ... OK
+* checking installed package size ... OK
+* checking package directory ... OK
+* checking for future file timestamps ... OK
+* checking DESCRIPTION meta-information ... OK
+* checking top-level files ... NOTE
+Files ‘README.md’ or ‘NEWS.md’ cannot be checked without ‘pandoc’ being installed.
+* checking for left-over files ... OK
+* checking index information ... OK
+* checking package subdirectories ... OK
+* checking code files for non-ASCII characters ... OK
+* checking R files for syntax errors ... OK
+* checking whether the package can be loaded ... OK
+* checking whether the package can be loaded with stated dependencies ... OK
+* checking whether the package can be unloaded cleanly ... OK
+* checking whether the namespace can be loaded with stated dependencies ... OK
+* checking whether the namespace can be unloaded cleanly ... OK
+* checking loading without being on the library search path ... OK
+* checking whether startup messages can be suppressed ... OK
+* checking use of S3 registration ... OK
+* checking dependencies in R code ... OK
+* checking S3 generic/method consistency ... OK
+* checking replacement functions ... OK
+* checking foreign function calls ... OK
+* checking R code for possible problems ... OK
+* checking Rd files ... OK
+* checking Rd metadata ... OK
+* checking Rd line widths ... OK
+* checking Rd cross-references ... OK
+* checking for missing documentation entries ... OK
+* checking for code/documentation mismatches ... OK
+* checking Rd \usage sections ... OK
+* checking Rd contents ... OK
+* checking for unstated dependencies in examples ... OK
+* checking examples ... [8s/14s] OK
+* checking for unstated dependencies in ‘tests’ ... OK
+* checking tests ... SKIPPED
+* checking PDF version of manual ... OK
+* checking HTML version of manual ... NOTE
+Skipping checking HTML validation: no command 'tidy' found
+* checking for non-standard things in the check directory ... OK
+* checking for detritus in the temp directory ... OK
+* DONE
+
+Status: 2 NOTEs
+See
+  ‘/home/agsad.admin.ch/f80868656/projects/chents/chents.Rcheck/00check.log’
+for details.
+
diff --git a/log/test.log b/log/test.log
new file mode 100644
index 0000000..6c6325d
--- /dev/null
+++ b/log/test.log
@@ -0,0 +1,26 @@
+Loading required package: usethis
+ℹ Testing chents
+
+Attaching package: ‘testthat’
+
+The following object is masked from ‘package:devtools’:
+
+    test_file
+
+✔ | F W  S  OK | Context
+
+⠏ |          0 | chent                                                          
+⠏ |          0 | Generation of chent objects                                    
+⠋ |          1 | Generation of chent objects                                    
+⠸ |          4 | Generation of chent objects                                    
+✔ |          7 | Generation of chent objects [4.9s]
+
+⠏ |          0 | pai                                                            
+⠏ |          0 | Generation of pai objects                                      
+⠋ |          1 | Generation of pai objects                                      
+✔ |          8 | Generation of pai objects [6.8s]
+
+══ Results ═════════════════════════════════════════════════════════════════════
+Duration: 11.7 s
+
+[ FAIL 0 | WARN 0 | SKIP 0 | PASS 15 ]