Skip to content

Commit

Permalink
update vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
gisma committed May 4, 2024
1 parent 39dd9e8 commit a678a29
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 27 deletions.
46 changes: 27 additions & 19 deletions docs/articles/link2GI7.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ articles:
link2GI5: link2GI5.html
link2GI6: link2GI6.html
link2GI7: link2GI7.html
last_built: 2024-05-04T13:27Z
last_built: 2024-05-04T13:40Z
urls:
reference: https://r-spatial.github.io/link2GI/reference
article: https://r-spatial.github.io/link2GI/articles
Expand Down
14 changes: 7 additions & 7 deletions vignettes/link2GI7.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ vignette: >

# Reproducible Project Structure

Reproducible projects in R emphasize streamlined project setup and efficient workflows. There are quite a lot of very helpful tools in the R-universe like [`renv`](https://cran.r-project.org/package=renv), [`usethis`](https://cran.r-project.org/package=usethis) or [`here`](https://cran.r-project.org/package=here). which span from setting aup a stable R enviroment over generating individual projects structures to getting in an easy way the necessary pathes. Furthermore there are quite alot of packages dealing with project structures and templates for creating easy to use and transparent project structures. Namely [`tinProjects`](https://cran.r-project.org/package=tinyProject), [`prodigenr](https://cran.r-project.org/package=prodigenr) or [`workflowr`](https://cran.r-project.org/package=workflowr). `Workflowr`, `tinyProjects`, and `prodigenr` are R packages designed to facilitate reproducible research through automated project structuring and standardization. They all promote organized project directories, emphasize reproducibility by integrating with tools like `Git` and `renv`, and reduce manual setup efforts to ensure consistent and error-free project initialization. These packages help build a solid foundation for research and ensure that best practices include using separate scripts for data processing, analysis, and reporting, and combining code with narrative in R Markdown documents from start. This organized setup improves reproducibility by making it easier to maintain, share, and replicate research. For a more comprenesive overwiew have a look at CRAN overview [Repoducible Research ](https://cran.r-project.org/web/views/ReproducibleResearch.html).
Reproducible projects in R emphasize streamlined project setup and efficient workflows. There are quite a lot of very helpful tools in the R-universe like [`renv`](https://cran.r-project.org/package=renv), [`usethis`](https://cran.r-project.org/package=usethis) or [`here`](https://cran.r-project.org/package=here). which span from setting aup a stable R enviroment over generating individual projects structures to getting in an easy way the necessary pathes. Furthermore there are quite alot of packages dealing with project structures and templates for creating easy to use and transparent project structures. Namely [`tinProjects`](https://cran.r-project.org/package=tinyProject), [`prodigenr`](https://cran.r-project.org/package=prodigenr) or [`workflowr`](https://cran.r-project.org/package=workflowr) are R packages designed to facilitate reproducible research through automated project structuring and standardization. They all promote organized project directories, emphasize reproducibility by integrating with tools like `Git` and `renv`, and reduce manual setup efforts to ensure consistent and error-free project initialization. These packages help build a solid foundation for research and ensure that best practices include using separate scripts for data processing, analysis, and reporting, and combining code with narrative in R Markdown documents from start. This organized setup improves reproducibility by making it easier to maintain, share, and replicate research. For a more comprenesive overwiew have a look at CRAN [Repoducible Research View ](https://cran.r-project.org/web/views/ReproducibleResearch.html).

## Why initProj?
## Why initProj then?
In the context of link2GI, which relies heavily on third-party command-line APIs and requires complex and stable folder and file structures, a flexible, lightweight R project setup greatly enhances the integration of OS command-line tools into spatial workflows by:

1. **Streamlining integration**: Simplifies the integration of essential command-line tools such as GDAL or OGR for advanced geospatial processing.
2. **Improving Data Exchange**: Organized variable and metadata management ensures accurate and efficient data transfer between different processes and tools.
3. **Enhanced Cross-Platform Compatibility**: Facilitates adaptability across operating systems, which is critical when using multiple spatial analysis tools.
4. **Performance Optimization**: Leverages the speed and efficiency of command-line tools, especially beneficial when handling large spatial data sets.
1. **Streamlining integration**: Simplifies the integration of essential command-line tools such as GDAL or the sophisticated Orfeo Toolbox (OTB) and the growing universe of r(-)spatial packages for advanced geospatial processing.
2. **Improving data exchange**: Organized variable and metadata management ensures accurate and efficient data transfer between different and especially command-line based processes and APIs.
3. **Enhanced Cross-Platform Compatibility**: Facilitates adaptability across operating systems, which is critical when using multiple spatial analysis tools, even more so when using different shells.
4. **Performance Optimization**: Switching between generic R and command-line tools takes advantage of the speed and efficiency of command-line tools, which is especially beneficial when handling large spatial datasets.

For this reason, a lightweight approach that integrates `git` `renv` and flexible folder and package setups is included in the link2GI package, as it is more suitable than the existing approaches and increases efficiency, accuracy, and performance in geospatial workflows.
For this reason, the link2GI package includes a lean and lightweight but focused approach that integrates `git', `renv', and a flexible folder and package setup process that is simpler than existing approaches and increases efficiency, accuracy, and performance in geospatial workflows.

### Using the RStudio GUI

Expand Down

0 comments on commit a678a29

Please sign in to comment.