rebuild vignettes - devtools::build_vignettes()

.Rbuildignore

@@ -6,3 +6,5 @@ Makefile
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^doc$
+^Meta$

.gitignore

@@ -38,3 +38,5 @@ test/
 dashboard_test/
 .sentinel*
 inst/doc
+/doc/
+/Meta/

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: matsim
 Type: Package
 Title: R library for interfacing with MATSim agent-based microsimulation model
-Version: 0.2.0
+Version: 0.2.1
 Authors@R: c(
   person("Billy", "Charlton", email = "[email protected]", role=c("aut","cre")),
   person("Oleksandr", "Soboliev", role="aut"),

doc/Exampleproject.R

@@ -1,4 +1,4 @@
-## ---- include=FALSE-----------------------------------------------------------
+## ----include=FALSE------------------------------------------------------------
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>"
@@ -20,10 +20,10 @@ knitr::opts_chunk$set(
 ## ----eval=FALSE---------------------------------------------------------------
 #   plot_mainmode_barchart(output_trips)
 
-## ---- eval = FALSE------------------------------------------------------------
+## ----eval = FALSE-------------------------------------------------------------
 #  trips_originating <- process_filter_by_shape(output_trips, leipzig_shp, crs = 25832, spatial_type = "originating" )
 
-## ---- eval = FALSE------------------------------------------------------------
+## ----eval = FALSE-------------------------------------------------------------
 #  #loading the scenario data
 #  output_trips_scenario <- read_output_trips(trips_file_scenario_path, n_max = 5000)
 #  

doc/Exampleproject.Rmd

@@ -115,4 +115,4 @@ plot_map_trips(trips_originating, crs = 25832)
 
 The result is an interactive map using leaflet, showing the places of origin in blue and the destinations in red. (The following image is a screenshot)
 
-![Leipzig - originating trips](../inst/extdata/Leipzig_map.png)
+![Leipzig - originating trips](./Leipzig_map.png)

doc/Introduction.R

@@ -1,4 +1,4 @@
-## ---- include = FALSE---------------------------------------------------------
+## ----include = FALSE----------------------------------------------------------
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>"

doc/Namings.R

@@ -1,4 +1,4 @@
-## ---- include = FALSE---------------------------------------------------------
+## ----include = FALSE----------------------------------------------------------
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>"

doc/Namings.Rmd

@@ -17,9 +17,9 @@ knitr::opts_chunk$set(
 
 #### Overview
 
-All function names are built using the same naming template. Functions start with a specific verb (e.g. read, plot, process) that describes their main usage. They are sorted into [function types] according to this usage.
+All function names are created following the same pattern. They start with a specific verb (e.g. read, plot, process) that describes their main function. They are sorted into [function types] according to this usage. This, and all following naming elements are followed by an underscore. 
 
-This, and all following naming elements are followed by an underscore. The second element is optional. It further specifies the type of action that is performed and can be used to distinguish similar functions. In the following guide this element is called [clarification]. An example for this element is [compare], which is used in all functions that compare two data sets.
+The second element is optional. It further specifies the type of action that is performed and can be used to distinguish similar functions. In the following guide this element is called [clarification]. An example for this element is [compare], which is used in all functions that compare two data sets.
 
 The next element specifies the data or the columns used. For example the column [mainmode] or the MATSim file [output_trips].
 
@@ -29,7 +29,7 @@ The last element can be used to specify the output type. This is important for t
 
 #### Template
 
-So to summarize every naming template looks similar to:
+So to summarize, every naming template looks similar to:
 
 **[function_type]\_{clarification}\_[data]\_{by}\_{category}\_{and}\_...\_{output_type}**
 
@@ -54,7 +54,7 @@ For processing functions:
 - filter
 - convert
 
-**[data]**: Refers to the file or column that the function is handling or manipulating. Examples include "arrtime" (arrival time), "distance" (distance traveled), "mainmode" (main transportation mode). Can be read with the function `str()`
+**[data]**: Refers to the file or column that the function is handling or manipulating. Examples include "arrtime" (arrival time), "distance" (distance traveled), "mainmode" (main transportation mode). Can be read with the function `str()`.
 
 **{by}**: This part is optional and indicates that the data is filtered or grouped by a specific category or factor. It serves as a connector between the [data] and [category] components.
 

doc/Namings.html

@@ -241,13 +241,13 @@ <h1 class="title toc-ignore">Namings</h1>
 
 <div id="overview" class="section level4">
 <h4>Overview</h4>
-<p>All function names are built using the same naming template.
-Functions start with a specific verb (e.g. read, plot, process) that
-describes their main usage. They are sorted into [function types]
-according to this usage.</p>
-<p>This, and all following naming elements are followed by an
-underscore. The second element is optional. It further specifies the
-type of action that is performed and can be used to distinguish similar
+<p>All function names are created following the same pattern. They start
+with a specific verb (e.g. read, plot, process) that describes their
+main function. They are sorted into [function types] according to this
+usage. This, and all following naming elements are followed by an
+underscore.</p>
+<p>The second element is optional. It further specifies the type of
+action that is performed and can be used to distinguish similar
 functions. In the following guide this element is called
 [clarification]. An example for this element is [compare], which is used
 in all functions that compare two data sets.</p>
@@ -264,7 +264,7 @@ <h4>Overview</h4>
 </div>
 <div id="template" class="section level4">
 <h4>Template</h4>
-<p>So to summarize every naming template looks similar to:</p>
+<p>So to summarize, every naming template looks similar to:</p>
 <p><strong>[function_type]_{clarification}_[data]_{by}_{category}_{and}_…_{output_type}</strong></p>
 <p><strong>[function_type]</strong>: Describes the type of the function,
 indicating its primary purpose or operation. For example, “plot” to plot
@@ -298,7 +298,7 @@ <h4>Template</h4>
 function is handling or manipulating. Examples include “arrtime”
 (arrival time), “distance” (distance traveled), “mainmode” (main
 transportation mode). Can be read with the function
-<code>str()</code></p>
+<code>str()</code>.</p>
 <p><strong>{by}</strong>: This part is optional and indicates that the
 data is filtered or grouped by a specific category or factor. It serves
 as a connector between the [data] and [category] components.</p>