Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,11 @@ updates:
directory: "/"
schedule:
interval: "weekly"
groups:
github-actions:
patterns:
- "*"
- package-ecosystem: "uv"
directory: "/"
schedule:
interval: "weekly"
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ pytask-r is available on [PyPI](https://pypi.org/project/pytask-r) and
[Anaconda.org](https://anaconda.org/conda-forge/pytask-r). Install it with

```console
$ pip install pytask-r
$ uv add pytask-r

# or

$ conda install -c conda-forge pytask-r
$ pixi add pytask-r
```

You also need to have R installed and `Rscript` on your command line. Test it by typing
Expand All @@ -34,14 +34,16 @@ the following on the command line
Rscript --help
```

If an error is shown instead of a help page, you can install R with `conda`.
If an error is shown instead of a help page, you can install R with `pixi`.

```console
conda install -c conda-forge r-base
pixi add r-base
```

Or install install R from the official [R Project](https://www.r-project.org/).

For serializing task data, install either `r-jsonlite` for JSON or `r-yaml` for YAML.

## Usage

To create a task that runs an R script, define a task function with the `@mark.r`
Expand Down Expand Up @@ -246,3 +248,12 @@ r_options = ["--vanilla"]
## Changes

Consult the [release notes](CHANGES.md) to find out about what is new.

## Developer

To run the tests, `r-base` and its dependencies need to be installed. The recommended
command is

```console
pixi global install r-base --with r-jsonlite --with r-yaml
```
2 changes: 1 addition & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ test-cov *FLAGS:

# Run type checking
typing:
uv run --group typing --group test ty check src/ tests/
uv run --group typing --group test --isolated ty check src/ tests/

# Run linting
lint:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pytask_r = "pytask_r.plugin"

[dependency-groups]
test = ["pytask-parallel", "pytest", "pytest-cov", "pytest-xdist", "pyyaml"]
typing = ["ty>=0.0.7"]
typing = ["ty>=0.0.8"]

[build-system]
requires = ["hatchling", "hatch-vcs"]
Expand Down