new package name : cppRosm

Author: ischlo

.Rbuildignore

@@ -1,4 +1,4 @@
-^cppRnet\.Rproj$
+^cppRosm\.Rproj$
 ^\.Rproj\.user$
 ^Makefile$
 ^LICENSE\.md$

DESCRIPTION

@@ -1,4 +1,4 @@
-Package: cppRnet
+Package: cppRosm
 Title: Fast en Efficient OSM Data in R
 Version: 1.0.0
 Authors@R: 
@@ -7,8 +7,8 @@ Authors@R:
 Description: A set of fast and user friendly functions for working with large
     OpenStreetMap extract data. Developed on top of the C++ libosmium library.
 License: MIT + file LICENSE
-URL: https://github.com/ischlo/cppRnet, https://ischlo.github.io/cppRnet/
-BugReports: https://github.com/ischlo/cppRnet/issues
+URL: https://github.com/ischlo/cppRosm, https://ischlo.github.io/cppRosm/
+BugReports: https://github.com/ischlo/cppRosm/issues
 Imports: 
     cli,
     data.table,

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 cppRnet authors
+Copyright (c) 2024 cppRosm authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

NAMESPACE

@@ -14,4 +14,4 @@ importFrom(data.table,.N)
 importFrom(data.table,.NGRP)
 importFrom(data.table,.SD)
 importFrom(data.table,data.table)
-useDynLib(cppRnet, .registration = TRUE)
+useDynLib(cppRosm, .registration = TRUE)

NEWS.md

@@ -1,7 +1,7 @@
-# cppRnet 1.0.0
+# cppRosm 1.0.0
 
 * Big update since the package no longer depends on a local installation of *protozero* and *libosmium*, they are imported and built with the package, making it mostly self sufficient. 
 
-# cppRnet 0.0.9000
+# cppRosm 0.0.9000
 
 * Added a `NEWS.md` file to track changes to the package.

R/RcppExports.R

@@ -2,10 +2,10 @@
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
 cpp_extract_graph <- function(file) {
-    .Call(`_cppRnet_cpp_extract_graph`, file)
+    .Call(`_cppRosm_cpp_extract_graph`, file)
 }
 
 cpp_extract_data <- function(file, main_sel) {
-    .Call(`_cppRnet_cpp_extract_data`, file, main_sel)
+    .Call(`_cppRosm_cpp_extract_data`, file, main_sel)
 }
 

R/construct_geom.R

@@ -2,16 +2,16 @@
 #'@title construct_geom
 #'@name construct_geom
 #'@description
-#'From a cppRnet data table, make the geometries.
+#'From a cppRosm data table, make the geometries.
 #'
-#'@param cpprnet_dt a data table obtained with cppRnet extract_data()
+#'@param cpprnet_dt a data table obtained with cppRosm extract_data()
 #'@param complete bool. TRUE to reconstruct Polygons, else use just points.
 #'@param cores integer. Run the computation on multiple cores using `parallel`.
 #'@examples
-#'cpprnet_filepath <- system.file(package = 'cppRnet','extdata','map.osm')
-#'cpprnet_dt <- cppRnet::extract_data(filename = cpprnet_filepath)
+#'cpprnet_filepath <- system.file(package = 'cppRosm','extdata','map.osm')
+#'cpprnet_dt <- cppRosm::extract_data(filename = cpprnet_filepath)
 #'
-#'cppRnet::construct_geom(cpprnet_dt,complete=TRUE)
+#'cppRosm::construct_geom(cpprnet_dt,complete=TRUE)
 #'
 #'head(cpprnet_dt$geometry)
 #'

R/cppRnet-package.R renamed to R/cppRosm-package.R

@@ -12,6 +12,6 @@
 #' @importFrom data.table .SD
 #' @importFrom data.table data.table
 #' @importFrom Rcpp sourceCpp
-#' @useDynLib cppRnet, .registration = TRUE
+#' @useDynLib cppRosm, .registration = TRUE
 ## usethis namespace: end
 NULL

R/extract_data.R

@@ -8,9 +8,9 @@
 #'@param filename a local osm extract file with .osm or .osm.pbf extension.
 #'@param main_keys a vector containing main keys to extract the values for. Check osm map features or vignette for a full detail.
 #'@examples
-#' local_osm_filename <- system.file("extdata",'map.osm', package = "cppRnet")
+#' local_osm_filename <- system.file("extdata",'map.osm', package = "cppRosm")
 #'
-#' data <- cppRnet::extract_data(local_osm_filename)
+#' data <- cppRosm::extract_data(local_osm_filename)
 #' head(data)
 #' head(data$attrs)
 #'@return a data table with several main columns, including one called `attrs` which contains lists 

R/extract_graph.R

@@ -7,9 +7,9 @@
 #'
 #'@param filename a local osm extract file with .osm or .osm.pbf extension.
 #'
-# local_osm_filename <- system.file("extdata",'map.osm', package = "cppRnet")
+# local_osm_filename <- system.file("extdata",'map.osm', package = "cppRosm")
 #
-# cppRnet::extract_graph(local_osm_filename)
+# cppRosm::extract_graph(local_osm_filename)
 #'
 #'@return this function returns the value 1 to the R environment when it's completed.
 #' It writes out 2 files containing nodes and segments. The files are written in the current directory and are called:
@@ -31,4 +31,4 @@ extract_graph <- function(filename){
   # return(graph_data)
 
   cpp_extract_graph(filename)
-}
+}

R/filter_sec.R

@@ -3,25 +3,25 @@
 #'@title Filtering secondary tags
 #'@name filter_sec
 #'@description
-#'This function provides a handy way of filtering a cppRnet data set for specific secondary tags.
+#'This function provides a handy way of filtering a cppRosm data set for specific secondary tags.
 #'It will return a data set to which will be added new columns based on the specific secondary keys and values that 
 #'are looked for.
 #'
-#'@param data a cppRnet data set, with an `attrs` column.
+#'@param data a cppRosm data set, with an `attrs` column.
 #'@param keys either a vector of valid key parameters, or a named list where names correspond to keys and 
 #'attributes are vectors of matching values.
 #'@param cores number of cores to parallelise the computation
 #'
 #'@examples
 #'
-#'test_file <- system.file(package = 'cppRnet','extdata','map.osm')
-#'data <- cppRnet::extract_data(test_file)
+#'test_file <- system.file(package = 'cppRosm','extdata','map.osm')
+#'data <- cppRosm::extract_data(test_file)
 #'
 #'
 #'keys <- list("cuisine"=c("pizza","japanese")
 #'             ,"takeaway"=c("yes"))
 #'
-#'data_filtered <- cppRnet::filter_sec(data,keys)
+#'data_filtered <- cppRosm::filter_sec(data,keys)
 #'
 #'@export
 filter_sec <- function(data,keys,cores=1){

R/map_features.R

@@ -63,4 +63,4 @@ map_keys_1st <- c('aerialway'
                   ,'waterway'
                   )
 
-# all the other keys are considered 2nd level
+# all the other keys are considered 2nd level

R/oop.R

@@ -1,17 +1,17 @@
 # oop 
-# creating the cppRnet data.frame/data.table S3 class for better consistency.
+# creating the cppRosm data.frame/data.table S3 class for better consistency.
 
 # new_myclass()
 # validate_myclass()
 # myclass()
 
-# a cppRnet class object is also a data.frame, or data.table. 
+# a cppRosm class object is also a data.frame, or data.table. 
 # it has a few restrictions, mainly the attrs column that should contain named lists.
 # an id column with osm ids.
 # a lon and lat columns
 # a key and value columns in the simplest form. 
 
-# any method of the cppRnet package that uses cppRnet data tables should ideally do a validity check.
+# any method of the cppRosm package that uses cppRosm data tables should ideally do a validity check.
 
 new_cppRnet_dt <- function(dt = data.frame()){
 

README.Rmd

@@ -4,10 +4,10 @@ output: github_document
 ---
 
 <!-- badges: start -->
-[![R-CMD-check](https://github.com/ischlo/cppRnet/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ischlo/cppRnet/actions/workflows/R-CMD-check.yaml)
+[![R-CMD-check](https://github.com/ischlo/cppRosm/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ischlo/cppRosm/actions/workflows/R-CMD-check.yaml)
 ![](https://github.com/ischlo/cppSim/actions/workflows/rhub.yaml/badge.svg)
 [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
-![](https://github.com/ischlo/cppRnet/actions/workflows/pkgdown.yaml/badge.svg)
+![](https://github.com/ischlo/cppRosm/actions/workflows/pkgdown.yaml/badge.svg)
 
 <!-- badges: end -->
 
@@ -30,7 +30,7 @@ This section is under development, it will be a quick setup guide for the compil
 
 ## Installation
 
-The usage of `cppRnet` relies on the **libosmium** library, which needs to be installed on the machine. For more details on installation refer to the official website. On mac, it is recommended to install using [`brew`](https://brew.sh) with the following terminal command: 
+The usage of `cppRosm` relies on the **libosmium** library, which needs to be installed on the machine. For more details on installation refer to the official website. On mac, it is recommended to install using [`brew`](https://brew.sh) with the following terminal command: 
 
 ``` bash
 brew install libosmium
@@ -39,9 +39,9 @@ brew install libosmium
 Next, install the package itself from github:
 
 ``` r
-# remotes::install_github('ischlo/cppRnet')
-# devtools::install_github('ischlo/cppRnet')
-# pak::pak("ischlo/cppRnet")
+# remotes::install_github('ischlo/cppRosm')
+# devtools::install_github('ischlo/cppRosm')
+# pak::pak("ischlo/cppRosm")
 
 ```
 

README.md

@@ -2,7 +2,7 @@ Ivann Schlosser
 
 <!-- badges: start -->
 
-[![R-CMD-check](https://github.com/ischlo/cppRnet/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ischlo/cppRnet/actions/workflows/R-CMD-check.yaml)
+[![R-CMD-check](https://github.com/ischlo/cppRosm/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ischlo/cppRosm/actions/workflows/R-CMD-check.yaml)
 ![](https://github.com/ischlo/cppSim/actions/workflows/rhub.yaml/badge.svg)
 [![Lifecycle:
 stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
@@ -33,7 +33,7 @@ the compiled dependencies.
 
 ## Installation
 
-The usage of `cppRnet` relies on the **libosmium** library, which needs
+The usage of `cppRosm` relies on the **libosmium** library, which needs
 to be installed on the machine. For more details on installation refer
 to the official website. On mac, it is recommended to install using
 [`brew`](https://brew.sh) with the following terminal command:
@@ -45,9 +45,9 @@ brew install libosmium
 Next, install the package itself from github:
 
 ``` r
-# remotes::install_github('ischlo/cppRnet')
-# devtools::install_github('ischlo/cppRnet')
-# pak::pak("ischlo/cppRnet")
+# remotes::install_github('ischlo/cppRosm')
+# devtools::install_github('ischlo/cppRosm')
+# pak::pak("ischlo/cppRosm")
 ```
 
 The package will detect the presence of the library and notify you if it

_pkgdown.yml

@@ -1,4 +1,4 @@
-url: https://ischlo.github.io/cppRnet/
+url: https://ischlo.github.io/cppRosm/
 template:
   bootstrap: 5
 

man/construct_geom.Rd

@@ -12,7 +12,7 @@ Rcpp::Rostream<false>& Rcpp::Rcerr = Rcpp::Rcpp_cerr_get();
 
 // cpp_extract_graph
 int cpp_extract_graph(const std::string& file);
-RcppExport SEXP _cppRnet_cpp_extract_graph(SEXP fileSEXP) {
+RcppExport SEXP _cppRosm_cpp_extract_graph(SEXP fileSEXP) {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
     Rcpp::RNGScope rcpp_rngScope_gen;
@@ -23,7 +23,7 @@ END_RCPP
 }
 // cpp_extract_data
 Rcpp::List cpp_extract_data(const std::string& file, Rcpp::CharacterVector main_sel);
-RcppExport SEXP _cppRnet_cpp_extract_data(SEXP fileSEXP, SEXP main_selSEXP) {
+RcppExport SEXP _cppRosm_cpp_extract_data(SEXP fileSEXP, SEXP main_selSEXP) {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
     Rcpp::RNGScope rcpp_rngScope_gen;
@@ -35,12 +35,12 @@ END_RCPP
 }
 
 static const R_CallMethodDef CallEntries[] = {
-    {"_cppRnet_cpp_extract_graph", (DL_FUNC) &_cppRnet_cpp_extract_graph, 1},
-    {"_cppRnet_cpp_extract_data", (DL_FUNC) &_cppRnet_cpp_extract_data, 2},
+    {"_cppRosm_cpp_extract_graph", (DL_FUNC) &_cppRosm_cpp_extract_graph, 1},
+    {"_cppRosm_cpp_extract_data", (DL_FUNC) &_cppRosm_cpp_extract_data, 2},
     {NULL, NULL, 0}
 };
 
-RcppExport void R_init_cppRnet(DllInfo *dll) {
+RcppExport void R_init_cppRosm(DllInfo *dll) {
     R_registerRoutines(dll, NULL, CallEntries, NULL, NULL);
     R_useDynamicSymbols(dll, FALSE);
 }