Skip to content

Commit

Permalink
Rebuild reference docs; update DESCRIPTION + NEWS
Browse files Browse the repository at this point in the history
  • Loading branch information
katieb1 committed Oct 13, 2024
1 parent 7d8e281 commit 2b2d2e6
Show file tree
Hide file tree
Showing 109 changed files with 28,508 additions and 6,009 deletions.
5 changes: 2 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: rsyncrosim
Type: Package
Title: The R Interface to 'SyncroSim'
Version: 2.0.0
Version: 2.0.1
Authors@R: c(
person("Colin", "Daniel", email = "colin.daniel@apexrms.com",
role = "aut"),
Expand Down Expand Up @@ -47,7 +47,6 @@ Collate:
'AAAClassDefinitions.R'
'addPackage.R'
'addRow.R'
'autogentags.R'
'backup.R'
'chart.R'
'chartCriteria.R'
Expand Down Expand Up @@ -106,7 +105,7 @@ Collate:
'useConda.R'
'version.R'
RoxygenNote: 7.3.2
URL: <https://syncrosim.github.io/rsyncrosim/>
URL: https://syncrosim.github.io/rsyncrosim/
BugReports: https://github.com/syncrosim/rsyncrosim/issues/
Config/testthat/edition: 3
Roxygen: list(markdown = TRUE)
2 changes: 0 additions & 2 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Generated by roxygen2: do not edit by hand

export("autogentags<-")
export("condaFilepath<-")
export("dependency<-")
export("description<-")
Expand All @@ -21,7 +20,6 @@ export(Session)
export(SsimLibrary)
export(addPackage)
export(addRow)
export(autogentags)
export(backup)
export(chart)
export(chartCriteria)
Expand Down
36 changes: 17 additions & 19 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
# rsyncrosim 2.0.0
# rsyncrosim 2.0.1

## Breaking changes

* Updates to make compatible with SyncroSim v3.0.0
* Libraries no longer require a package on creation
* `ssimLibrary()` `package` argument has been replaced with `packages`
* The `forceUpdate`, `addons`, and `template` arguments have been removed from `ssimLibrary()`
* `addPackage()` adds a package to a library (instead of installing from server)
* `removePackage()` removes a package from a library (instead of installing from server)
* Replaced the `package()` function with the `packages()` function
* The `run()` function no longer has a `jobs` argument. The number of multiprocessing jobs is determined using the `core_Multiprocessing` datasheet
* When calling `datasheet()` with `summary=TRUE`, the scope of the `ssimObject` specified is respected
* Removed the all deprecated functions, as well as the following functions: `datasheetRaster()`, `disableAddon()`, `enableAddon()`

## Bug fixes:

* Multiple bug fixes to `Folder` class
* Bug fix to `run()` when running multiple scenarios at a time
* Fix bug with empty datasheets returning NA values
* Update `addPackage()` to properly update package version in a library and fix bug caused by change in SyncroSim 3 console
* Fix `delete()` function
* Fix `backup` command
* Fix bug with internal folder code having wrong "ID"" case

## New features:

* Efficiency improvements for setting scenario dependencies
* `installPackage()` installs package(s) from the server or from a local file or folder and takes a `version` argument
* `removePackage()` uninstalls a package and takes a `version` argument
* New `createCondaEnv()` function for creating package conda environments using rsyncrosim
* Removed all references to deprecated `raster` package
* Updates to vignettes and documentation for version 2
* Add `deleteLibrary()` function specifically for deleting library objects
* Added suite of charting functions for creating SyncroSim charts from R

## Minor improvements and fixes

## Minor improvements and fixes
* Add warning for when library packages are not properly installed
* Add `forceUpdate` argument back to `ssimLibrary()`
* Change default `session()` path to "SyncroSim Studio"
* Ensure that a result scenario is output by `run()` even on run failure
* Add long path warning message
4 changes: 3 additions & 1 deletion R/datasheet.R
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,9 @@ NULL
#' myDatasheet$helloworldSpatial_RunControl
#'
#' # Get a Datasheet without pre-specified values
#' myDatasheetEmpty <- datasheet(myScenario, name = "RunControl", empty = TRUE)
#' myDatasheetEmpty <- datasheet(myScenario,
#' name = "helloworldSpatial_RunControl",
#' empty = TRUE)
#'
#' # If Datasheet is empty, do not return dependencies as factors
#' myDatasheetEmpty <- datasheet(myScenario,
Expand Down
2 changes: 1 addition & 1 deletion R/deleteLibrary.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#' @param session Session
#' @return "saved" or failure message.
#'
#' #' @examples
#' @examples
#' \donttest{
#' # Specify file path and name of new SsimLibrary
#' myLibraryName <- file.path(tempdir(), "testlib")
Expand Down
3 changes: 1 addition & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
url: https://syncrosim.github.io/rsyncrosim

template:
params:
bootswatch: flatly
bootstrap: 5
148 changes: 52 additions & 96 deletions docs/404.html

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

Loading

0 comments on commit 2b2d2e6

Please sign in to comment.