tidy documentation

Author: pachadotdev

.Rbuildignore

@@ -13,7 +13,6 @@ script.R
 ^\.clangd$
 ^compile_flags\.txt$
 ^compile_commands\.json$
-^cpp4rtest$
 ^codecov\.yml$
 ^R/coverage\.R$
 ^book$
@@ -32,3 +31,8 @@ script.R
 ^\.cache$
 ^docs$
 ^pkgdown$
+^cpp4rdummyols$
+^cpp4rgaussjordan$
+^cpp4romp$
+^cpp4rsimplexphase2$
+^cpp4rtest$

.github/workflows/R-CMD-check.yaml

@@ -33,7 +33,7 @@ jobs:
 
           # Use older ubuntu to maximise backward compatibility
           - {os: ubuntu-22.04,   r: 'devel', http-user-agent: 'release'}
-          - {os: ubuntu-22.04,   r: 'release'}
+          - {os: ubuntu-22.04,   r: 'release', custom: 'clang-format'}
           - {os: ubuntu-22.04,   r: 'release', custom: 'no-cpp4rtest'}
           - {os: ubuntu-22.04,   r: 'oldrel-1'}
           - {os: ubuntu-22.04,   r: 'oldrel-2'}
@@ -47,6 +47,14 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - uses: pachadotdev/clang-format@v1
+        if: matrix.config.custom == 'clang-format'
+        with:
+          version: '20'
+          files: 'src/*.cpp src/*.h inst/include/*.h'
+          auto-commit: true
+          commit-message: 'style: format C++ code in R package'
+
       - uses: r-lib/actions/setup-pandoc@v2
 
       - uses: r-lib/actions/setup-r@v2

.github/workflows/format.yaml

@@ -15,8 +15,8 @@ Description: Provides a header only, C++ interface to R's C
     to normal R function semantics and supports interaction with 'ALTREP'
     vectors.
 License: MIT + file LICENSE
-URL: https://cpp4r.r-lib.org, https://github.com/r-lib/cpp4r
-BugReports: https://github.com/r-lib/cpp4r/issues
+URL: https://cpp4r.org, https://github.com/pachadotdev/cpp4r
+BugReports: https://github.com/pachadotdev/cpp4r/issues
 Depends:
     R (>= 4.0.0)
 Suggests:

DESCRIPTION

@@ -20,7 +20,7 @@ site:
 install:
 	@Rscript -e 'devtools::install()'
 
-clang_format=`which clang-format-14`
+clang_format=`which clang-format-20`
 
 format: $(shell find . -name '*.h') $(shell find . -name '*.hpp') $(shell find . -name '*.cpp')
-	@${clang_format} -i $?
+	@${clang_format} -i $?

Makefile

@@ -5,10 +5,24 @@
 [![R-CMD-check](https://github.com/r-lib/cpp4r/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/cpp4r/actions/workflows/R-CMD-check.yaml)
 [![CRAN status](https://www.r-pkg.org/badges/version/cpp4r)](https://CRAN.R-project.org/package=cpp4r)
 [![Codecov test coverage](https://codecov.io/gh/r-lib/cpp4r/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/cpp4r?branch=main)
+[![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-yellow.svg)](https://www.buymeacoffee.com/pacha)
 <!-- badges: end -->
 
 cpp4r helps you to interact with R objects using C++ code.
-Its goals and syntax are similar to the excellent [Rcpp](https://cran.r-project.org/package=Rcpp) package.
+It is a fork of the [cpp11](https://cran.r-project.org/package=cpp) package with identical syntax and similar goals.
+
+cpp4r can be used as a replacement for cpp11 in existing or new packages. Think of cpp11 and cpp4r as MySQL and MariaDB: they are almost identical, but cpp4r has some extra features.
+
+After discussing some [pull requests](https://github.com/r-lib/cpp11/pulls/pachadotdev) with Hadley Wickham from Posit, it was mentioned that I should create my own fork to add the following features:
+
+- [x] Convert ordered and unordered C++ maps to R lists.
+- [x] Roxygen support on C++ side.
+- [x] Allow `dimnames` atribute with matrices on C++ side.
+- [x] Support nullable `external_ptr<>`.
+- [x] Use values added to a vector with `push_back()` immediately.
+- [x] Support bidirectional passing of complex numbers/vectors.
+- [x] Provide flexibility with data types (e.g., cpp4r's `as_integers()` and `as_doubles()` accept logical inputs while cpp11's do not).
+- [x] Some internal optimizations for better speed (e.g., https://github.com/r-lib/cpp11/pull/463 and https://github.com/r-lib/cpp11/pull/430).
 
 ## Using cpp4r in a package
 
@@ -19,7 +33,6 @@ LinkingTo: cpp4r
 ```
 
 Then decorate C++ functions you want to expose to R with `[[cpp4r::register]]`.
-*Note that this is a [C++11 attribute](https://en.cppreference.com/w/cpp/language/attributes), not a comment like is used in Rcpp.*
 
 cpp4r is a header only library with no hard dependencies and does not use a shared library, so it is straightforward and reliable to use in packages without fear of compile-time and run-time mismatches.
 
@@ -28,63 +41,16 @@ This ensures the headers will remain unchanged until you explicitly update them.
 
 ## Getting started
 
-See [vignette("cpp4r")](https://cpp4r.r-lib.org/articles/cpp4r.html) to get started using cpp4r in your scripts, particularly if you are new to C++ programming.
+See [vignette("cpp4r")](https://cpp4r.org/articles/cpp4r.html) to get started using cpp4r in your scripts, particularly if you are new to C++ programming.
 
 ## Getting help
 
-[Posit Community](https://forum.posit.co/) is the best place to ask for help using cpp4r or interfacing C++ with R.
-
-## Motivations
-
-[Rcpp](https://cran.r-project.org/package=Rcpp) has been a widely successful project, however over the years a number of issues and additional C++ features have arisen.
-Adding these features to Rcpp would require a great deal of work, or in some cases would be impossible without severely breaking backwards compatibility.
-
-**cpp4r** is a ground up rewrite of C++ bindings to R with different design trade-offs and features.
-
-Changes that motivated cpp4r include:
-
-- Enforcing [copy-on-write semantics](https://cpp4r.r-lib.org/articles/motivations.html#copy-on-write-semantics).
-- Improving the [safety](https://cpp4r.r-lib.org/articles/motivations.html#improve-safety) of using the R API from C++ code.
-- Supporting [ALTREP objects](https://cpp4r.r-lib.org/articles/motivations.html#altrep-support).
-- Using [UTF-8 strings](https://cpp4r.r-lib.org/articles/motivations.html#utf-8-everywhere) everywhere.
-- Applying newer [C++11 features](https://cpp4r.r-lib.org/articles/motivations.html#c11-features).
-- Having a more straightforward, [simpler implementation](https://cpp4r.r-lib.org/articles/motivations.html#simpler-implementation).
-- Faster [compilation time](https://cpp4r.r-lib.org/articles/motivations.html#compilation-speed) with lower memory requirements.
-- Being *completely* [header only](https://cpp4r.r-lib.org/articles/motivations.html#header-only) to avoid ABI issues.
-- Capable of [vendoring](https://cpp4r.r-lib.org/articles/motivations.html#vendoring) if desired.
-- More robust [protection](https://cpp4r.r-lib.org/articles/motivations.html#protection) using a much more efficient linked list data structure.
-- [Growing vectors](https://cpp4r.r-lib.org/articles/motivations.html#growing-vectors) more efficiently.
-
-See [vignette("motivations")](https://cpp4r.r-lib.org/articles/motivations.html) for full details on the motivations for writing cpp4r.
-
-## Conversion from Rcpp
+Please open an issue or email me. I will do my best to respond before 48 hours.
 
-See [vignette("converting")](https://cpp4r.r-lib.org/articles/converting.html) if you are already familiar with Rcpp or have an existing package that uses Rcpp and want to convert it to use cpp4r.
+## Contributing
 
-## Learning More
-
-- [Welding R and C++](https://www.youtube.com/watch?v=_kq0N0FNIjA) - Presentation at SatRday Columbus [(slides)](https://speakerdeck.com/jimhester/cpp4r-welding-r-and-c-plus-plus)
-
-
-## Internals
-
-See [vignette("internals")](https://cpp4r.r-lib.org/articles/internals.html) for details on the cpp4r implementation or if you would like to contribute to cpp4r.
+Contributions are welcome! Please see the [internals vignette](https://cpp4r.r-lib.org/articles/internals.html) for details about design choices and coding style.
 
 ## Code of Conduct
 
 Please note that the cpp4r project is released with a [Contributor Code of Conduct](https://cpp4r.r-lib.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
-
-## Thanks
-
-cpp4r would not exist without Rcpp.
-Thanks to the Rcpp authors, Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou, Nathan Russell, Douglas Bates and John Chambers for their work writing and maintaining Rcpp.
-
-## Clang format
-
-To match GHA, use clang-format-12 to format C++ code. With systems that provide clang-format-14 or newer, you can use Docker:
-
-```bash
-docker run --rm -v "$PWD":/work -w /work ubuntu:22.04 bash -lc "\
-  apt-get update && apt-get install -y clang-format-12 && \
-  find . -name '*.cpp' -o -name '*.hpp' -o -name '*.h' | xargs -r clang-format-12 -i"
-```

README.md

@@ -1,49 +1,5 @@
-url: https://cpp4r.r-lib.org
-
-authors:
-  "Jim Hester":
-    href: http://jimhester.com
-
 template:
-  package: tidytemplate
   bootstrap: 5
 
-  includes:
-    in_header: |
-      <script defer data-domain="cpp4r.r-lib.org,all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>
-
-development:
-  mode: auto
-
-reference:
-  - title: Registering C++ functions
-    contents:
-      - cpp_register
-  - title: Compiling C++ code interactively
-    contents:
-      - cpp_source
-  - title: Vendoring cpp4r
-    contents:
-      - cpp_vendor
-
-navbar:
-  type: default
-  left:
-    - text: Home
-      href: index.html
-    - text: Get started
-      href: articles/cpp4r.html
-    - text: Motivations
-      href: articles/motivations.html
-    - text: Converting
-      href: articles/converting.html
-    - text: FAQ
-      href: articles/FAQ.html
-    - text: Internals
-      href: articles/internals.html
-    - text: Reference
-      href: reference/index.html
-    - text: News
-      menu:
-      - text: "Change log"
-        href: news/index.html
+url: https://cpp4r.org
+destination: docs

_pkgdown.yml

@@ -0,0 +1,5 @@
+^cpp4rgaussjordan\.Rproj$
+^\.Rproj\.user$
+^LICENSE\.md$
+^vscode-install\.r$
+^\.gitignore$

cpp11.Rproj cpp4r.Rprojcpp11.Rproj renamed to cpp4r.Rproj

@@ -0,0 +1 @@
+.Rproj.user