add cran install instructions + some flexibility for lists

Author: pachadotdev

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: cpp4r
 Title: Header-Only 'C++' and 'R' Interface
-Version: 0.3.0
+Version: 0.3.1
 Authors@R: c(
     person("Mauricio", "Vargas Sepulveda", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-1017-7574")),
@@ -38,4 +38,4 @@ Config/Needs/cpp4r/register: brio, cli, decor, desc, glue, tibble, vctrs
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3

NEWS.md

@@ -1,5 +1,10 @@
+# cpp4r 0.3.1
+
+* Added support for implicit conversions for R lists
+
 # cpp4r 0.3.0
 
+* This is the first release on CRAN
 * Added `as_logicals()` and `as_strings()` in the same style of `as_doubles()` and `as_integers()`
 * Improved memory management for `r_vector` iterators
 * Slightly faster than `cpp11`

README.Rmd

@@ -51,6 +51,19 @@ Posit, it was mentioned that I should create my own fork to add the following fe
 Check the [documentation](https://cpp4r.org/) to get started using cpp4r in your scripts, particularly if you are new to
 C++ programming.
 
+You can install cpp4r from CRAN:
+
+```r
+install.packages("cpp4r", repos = "https://cloud.r-project.org")
+```
+
+Or the development version from GitHub:
+
+```r
+install.packages("remotes")
+remotes::install_github("pachadotdev/cpp4r")
+```
+
 ## Using cpp4r in a package
 
 Create a new package with `cpp4r::pkg_template("~/path/to/mypkg")` and then edit the generated files.

README.md

@@ -48,6 +48,19 @@ fork to add the following features:
 Check the [documentation](https://cpp4r.org/) to get started using cpp4r
 in your scripts, particularly if you are new to C++ programming.
 
+You can install cpp4r from CRAN:
+
+``` r
+install.packages("cpp4r", repos = "https://cloud.r-project.org")
+```
+
+Or the development version from GitHub:
+
+``` r
+install.packages("remotes")
+remotes::install_github("pachadotdev/cpp4r")
+```
+
 ## Using cpp4r in a package
 
 Create a new package with `cpp4r::pkg_template("~/path/to/mypkg")` and

cpp4rtest/DESCRIPTION

@@ -20,7 +20,7 @@ Suggests:
     xml2
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 Config/testthat/edition: 3
 Remotes: 
     pachadotdev/cpp4r

cpp4rtest/R/cpp4r.R

@@ -92,6 +92,14 @@ cpp4r_insert_ <- function(num_sxp) {
   .Call(`_cpp4rtest_cpp4r_insert_`, num_sxp)
 }
 
+cpp4r_named_list_push_back_ <- function() {
+  .Call(`_cpp4rtest_cpp4r_named_list_push_back_`)
+}
+
+cpp4r_named_list_c_style_ <- function() {
+  .Call(`_cpp4rtest_cpp4r_named_list_c_style_`)
+}
+
 ordered_map_to_list_ <- function(x) {
   .Call(`_cpp4rtest_ordered_map_to_list_`, x)
 }

cpp4rtest/src/cpp4r.cpp

@@ -0,0 +1,53 @@
+[[cpp4r::register]] list cpp4r_named_list_push_back_() {
+  writable::list result;
+
+  double one = 1.0, two = 2.0, three = 3.0;
+  // int four = 4;
+  // bool five = false;
+  // const char* six = "six";
+  std::string seven = "seven";
+  std::vector<int> eight = {8, 8, 8};
+  std::vector<double> nine = {9.0, 9.0, 9.0};
+  std::vector<std::string> ten = {"ten", "ten"};
+
+  result.push_back({"one"_nm = one});  // Using literal + assignment
+  result.push_back(named_arg("two", two));  // Using named_arg constructor
+  result.push_back({"three"_nm = three});  // Using literal + assignment
+  result.push_back({"four"_nm = 4});  // Using literal + assignment
+  result.push_back({"five"_nm = false});  // Using literal + assignment
+  result.push_back({"six"_nm = "six"});  // Using literal + assignment
+  result.push_back({"seven"_nm = std::string("seven")});  // Using literal + assignment
+  result.push_back({"eight"_nm = std::vector<int>{8, 8, 8}});  // Using literal + assignment + std::vector
+  result.push_back({"nine"_nm = std::vector<double>{9.0, 9.0, 9.0}});  // Using literal + assignment + std::vector
+  result.push_back({"ten"_nm = std::vector<std::string>{"ten", "ten"}});  // Using literal + assignment + std::vector
+
+  return result;
+}
+
+[[cpp4r::register]] list cpp4r_named_list_c_style_() {
+  writable::list result(10);  // Preallocate list of size 10
+
+  double one = 1.0, two = 2.0, three = 3.0;
+  int four = 4;
+  bool five = false;
+  const char* six = "six";
+  std::string seven = "seven";
+  std::vector<int> eight = {8, 8, 8};
+  std::vector<double> nine = {9.0, 9.0, 9.0};
+  std::vector<std::string> ten = {"ten", "ten"};
+
+  result[0] = one;
+  result[1] = two;
+  result[2] = three;
+  result[3] = four;
+  result[4] = five;
+  result[5] = six;
+  result[6] = seven;
+  result[7] = eight;
+  result[8] = nine;
+  result[9] = ten;
+
+  result.names() = {"one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten"};
+  
+  return result;
+}

cpp4rtest/src/lists.h

@@ -34,6 +34,7 @@ using namespace cpp4r;
 #include "sum_int.h"
 #include "sum_Rcpp.h"
 #include "truncate.h"
+#include "lists.h"
 
 #include "test-runner.h"
 #include "test-as.h"

cpp4rtest/src/main.cpp

@@ -0,0 +1,18 @@
+test_that("creating named lists with push_back or C-style gives the same result", {
+  res1 <- cpp4r_named_list_push_back_()
+  res2 <- cpp4r_named_list_c_style_()
+
+  expect_equal(res1, res2)
+
+  expect_equal(res1[[1]], 1.0)
+  expect_equal(res1[[2]], 2.0)
+  expect_equal(res1[[3]], 3.0)
+  expect_equal(res1[[4]], 4L)
+  expect_equal(res1[[5]], FALSE)
+
+  expect_equal(res2[["six"]], "six")
+  expect_equal(res2[["seven"]], "seven")
+  expect_equal(res2[["eight"]], rep(8L, 3L))
+  expect_equal(res2[["nine"]], rep(9.0, 3L))
+  expect_equal(res2[["ten"]], rep("ten", 2L))
+})