Skip to content

circuitscaper

0.1.1Package record

'Circuitscape' and 'Omniscape' Connectivity Analysis via 'Julia'

0packages depend
2.8Kdownloads / year
40.2%test coverage
13/13flavors OK

Overview

About

Provides an R-native interface to the 'Circuitscape.jl' and 'Omniscape.jl' 'Julia' packages for landscape connectivity modeling using circuit theory. Users work entirely in R with familiar objects (SpatRaster, file paths) while 'Julia' handles computation invisibly. Supports all four 'Circuitscape' modes (pairwise, one-to-all, all-to-one, advanced) and 'Omniscape' moving-window analysis. Methods are described in McRae (2006) doi:10.1111/j.0014-3820.2006.tb00500.x and Landau et al. (2021) doi:10.21105/joss.02829.

Changes in 0.1.1

New features

  • New os_condition() constructor gives os_run() full access to Omniscape's conditional connectivity (#2):
  • "within" comparisons with user-specified bounds (lower, upper).
  • Present-vs-future comparisons (future), in which sources' present-day values are compared against targets' future values, as in climate-tracking connectivity analyses.
  • Two simultaneous conditions, by passing a list of two os_condition() objects.
  • os_run() now warns when a condition layer has missing values at source cells, which Omniscape does not filter.
  • All cs_*() functions and os_run() now warn if the installed Circuitscape.jl or Omniscape.jl does not recognize a configuration option written by circuitscaper, rather than letting the option silently have no effect.
Show all changes in 0.1.1Hide the rest of the changes in 0.1.1

Bug fixes

  • In 0.1.0, os_run()'s condition_type argument was written to the Omniscape configuration under a key Omniscape does not recognize, so it was silently ignored. All conditional analyses instead used Omniscape's defaults, "within" with bounds of 0 and 0: a source was connected to a target only if its condition value exactly equaled the median value of the target block. This was neither the documented behavior (an unbounded range) nor the requested "equal" comparison. **Results from 0.1.0 that used condition should be rerun.**
  • In 0.1.0, four_neighbors = TRUE was written to the Circuitscape configuration under an unrecognized key and silently ignored in cs_pairwise(), cs_one_to_all(), cs_all_to_one(), and cs_advanced(); all analyses used 8-neighbor connectivity. **Results from 0.1.0 that used four_neighbors = TRUE should be rerun.**

Breaking changes and deprecations

  • Passing a raster directly as os_run(condition = ) is now shorthand for os_condition(x, type = "equal"). Use os_condition() for "within" comparisons, which now require explicit bounds.
  • os_run()'s condition_type argument is deprecated. condition_type = "equal" still works with a warning; condition_type = "within" now errors, since it has no way to specify bounds.

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 5.3 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OK2026-08-05
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK5 OK2026-04-10
Advisories

none known

Documentation

In release 0.1.1
READMEYes · 344 wordsVignettesYes · 1 · staticNEWSYes · 100% structured · mentions 0.1.1Citation fileNoWebsiteYes · pkgdown
Description cites a JOSS paper
Help pages
10 (1 internal)includes a package overview page
Examples that run
89%8 run in a plain check (7 of them under a condition) · 1 never run
Exported functions with examples
100%
Documented parameters
95%
Return-value docs
100%
Help pages citing references
70%

Downloads

2.8K
CRAN downloads in the past year
Rank #8,280 · ~8/day · ~232/mo
Daily download trend is not available in this view yet.
45430 days
1.1K90 days
2.8K1 year
Compare downloads with other packages →
Also on45 r2u9 autocran

Repository

4Stars
0Forks
1Open issues
0Open PRs
2Releases
64Commits
1Commit identities
64 commits · Last activity 2026-10-20 · +33.3% stars, 30d · Default branch at 0.1.1.9000, ahead of CRAN 0.1.1 (checked 2026-10-21)
Responsiveness
How these are sampled
PRs merged (all time)
not measured
Median days to close, 50 most recently updated closed issues
15
Median days to close, 50 most recently updated closed PRs
not measured

Stars over time

2026-04-22 · 12026-10-17 · 4
PracticesBeta

7 development-tooling and community-health practices detected across 3 families in the upstream repository

Checks run against github.com/matthewkling/circuitscaper on 2026-10-21.

Continuous integration (2)
GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (4)
README.Rmdpkgdown

GitHub Pages site last deployed 2026-10-20 · The repository has a site deploy workflow

pkgdown site last built 2026-10-20

CRAN release process (1)
cran-comments.md
How this is detected·Detection ruleset v4 (2026-10-20)
AI coding toolsBeta

This repository shows signs of AI coding tools.

  • Claude Codefirst seen 2026-02-21
    Named in .Rbuildignore: .claude
    Commits: at least 43 crediting it in the message
Models named in its commits
  • Claude Opus 4.640 commits · Feb to Mar 2026
  • Claude Opus 5.53 commits · Oct 2026
Counts are commits, not lines of code. Commits by a tool's accounts count once across all of its accounts. Commits crediting it are the largest count among its credit lines, a minimum.How this is detected·Detection ruleset v4 (updated 2026-09-27)

Dependencies

Declared dependencies
5 external dependencies (excludes base and recommended)

Installing circuitscaper adds 9 packages (6 with compiled code, 5.6 MB of source tarballs). Heaviest: Rcpp 1.8 MB, terra 1.5 MB, JuliaCall 1.4 MB.

Depends (1)
R >= 4.0
Imports (3)
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect

Nothing depends on this yet.

People & History

People (1)
Author, Maintainer since 0.1.0 (2026), Copyright holder
Releases (2)

Pick two releases to compare their code metrics.

  • 0.1.1Latest
    record
    2026-10-01 · current release · diff ↗ ·
    added 1 export
    os_condition
  • R
    R 4.6.0 released · 2026-04-24
  • 0.1.0
    record
    2026-04-09
  • R
    R 4.5.0 released · 2025-04-11

Package metadata

First published
2026-04-09
Total releases
2 / 1 yrs
License
MIT + file LICENSE OSI
Minimum R
≥ 4.0
Download size
181 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("circuitscaper")
Kling, M. (2026). circuitscaper: 'Circuitscape' and 'Omniscape' Connectivity Analysis via 'Julia' (Version 0.1.1) [Computer software]. https://doi.org/10.32614/CRAN.package.circuitscaper

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for circuitscaper version 0.1.1 [Data set]. HJJB, LLC. Data release v2026-10-25. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy