
<!-- README.md is generated from README.Rmd. Please edit that file -->

# rsyncrosim <img src="man/figures/logo.png" align="right" width=140/>

## The R interface to SyncroSim

[![License:
MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Downloads](https://cranlogs.r-pkg.org/badges/rsyncrosim?color=brightgreen)](https://CRAN.R-project.org/package=rsyncrosim/)
<!-- [![Codecov test coverage](https://codecov.io/gh/syncrosim/rsyncrosim/branch/dev/graph/badge.svg)](https://codecov.io/gh/syncrosim/rsyncrosim?branch=dev) -->

[![Latest
Release](https://img.shields.io/github/v/release/syncrosim/rsyncrosim?label=Latest%20Release)](https://github.com/syncrosim/rsyncrosim/releases/latest)
[![CRAN
Version](https://img.shields.io/cran/v/rsyncrosim?label=CRAN%20Version)](https://CRAN.R-project.org/package=rsyncrosim)
[![GitHub
Version](https://img.shields.io/github/r-package/v/syncrosim/rsyncrosim?label=GitHub%20Version)](https://github.com/syncrosim/rsyncrosim/blob/dev/DESCRIPTION)

## About SyncroSim

<a href="https://syncrosim.com/" target="_blank">**SyncroSim**</a> is an
open science tool for organizing tabular and spatial data, running
geospatial simulation code, and visualizing model results. Its flexible
framework supports the integration of code across multiple scripting
languages and the use and creation of customizable **SyncroSim**
<a href="https://docs.syncrosim.com/how_to_guides/package_overview.html" target="_blank">packages</a>,
allowing you to tailor the platform to your specific needs.

For more details, please consult the **SyncroSim**
<a href="https://docs.syncrosim.com/" target="_blank">online
documentation</a>.

## About `rsyncrosim`

**rsyncrosim** is an open-source R package that leverages the
**SyncroSim** command-line interface to simplify scripting model
workflows for **SyncroSim** in R. This R package provides functions for
building models from scratch, running those models, and accessing both
spatial and tabular model outputs. The **rsyncrosim** package is
designed to work with any **SyncroSim** package.

A key feature of the **rsyncrosim** package is its seamless integration
with <a href="https://syncrosim.com/studio/" target="_blank">**SyncroSim
Studio**</a>, allowing you to interactively explore and validate your
models in the user interface as you step through your R code.
Additionally, **rsyncrosim** facilitates the creation of a permanent,
reproducible record of the entire modeling workflow – including pre- and
post-processing of model inputs and outputs – in an R script.

### Installation

- [Download](https://cran.r-project.org/package=rsyncrosim/) from CRAN

- [Download](https://syncrosim.github.io/rsyncrosim/articles/a06_rsyncrosim_install_github.html)
  from GitHub

### Getting Started

- Run the vignettes:

  - [Introduction to
    `rsyncrosim`](https://syncrosim.github.io/rsyncrosim/articles/a01_rsyncrosim_vignette_basic.html)

  - [`rsyncrosim`: introduction to
    uncertainty](https://syncrosim.github.io/rsyncrosim/articles/a02_rsyncrosim_vignette_uncertainty.html)

  - [`rsyncrosim`: introduction to
    pipelines](https://syncrosim.github.io/rsyncrosim/articles/a03_rsyncrosim_vignette_pipelines.html)

  - [`rsyncrosim`: introduction to spatial
    data](https://syncrosim.github.io/rsyncrosim/articles/a04_rsyncrosim_vignette_spatial.html)

  - [Introduction to `ST-Sim` in
    `rsyncrosim`](https://syncrosim.github.io/rsyncrosim/articles/a05_rsyncrosim_stsim_vignette.html)

- View the package
  [documentation](https://cran.r-project.org/package=rsyncrosim/rsyncrosim.pdf)
