Skip to content

Commit c505658

Browse files
committed
Initial commit
0 parents  commit c505658

20 files changed

+243
-0
lines changed

.Rbuildignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
^mlr3torch\.Rproj$
2+
^\.Rproj\.user$
3+
^README\.Rmd$
4+
^\.github$

.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

.github/workflows/R-CMD-check.yaml

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
2+
# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
pull_request:
9+
branches:
10+
- main
11+
- master
12+
13+
name: R-CMD-check
14+
15+
jobs:
16+
R-CMD-check:
17+
runs-on: ${{ matrix.config.os }}
18+
19+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
20+
21+
strategy:
22+
fail-fast: false
23+
matrix:
24+
config:
25+
- {os: windows-latest, r: 'release'}
26+
- {os: macOS-latest, r: 'release'}
27+
- {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
28+
- {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
29+
30+
env:
31+
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
32+
RSPM: ${{ matrix.config.rspm }}
33+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
34+
35+
steps:
36+
- uses: actions/checkout@v2
37+
38+
- uses: r-lib/actions/setup-r@v1
39+
with:
40+
r-version: ${{ matrix.config.r }}
41+
42+
- uses: r-lib/actions/setup-pandoc@v1
43+
44+
- name: Query dependencies
45+
run: |
46+
install.packages('remotes')
47+
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
48+
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
49+
shell: Rscript {0}
50+
51+
- name: Restore R package cache
52+
if: runner.os != 'Windows'
53+
uses: actions/cache@v2
54+
with:
55+
path: ${{ env.R_LIBS_USER }}
56+
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
57+
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
58+
59+
- name: Install system dependencies
60+
if: runner.os == 'Linux'
61+
run: |
62+
while read -r cmd
63+
do
64+
eval sudo $cmd
65+
done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "20.04"))')
66+
67+
- name: Install dependencies
68+
run: |
69+
remotes::install_deps(dependencies = TRUE)
70+
remotes::install_cran("rcmdcheck")
71+
shell: Rscript {0}
72+
73+
- name: Check
74+
env:
75+
_R_CHECK_CRAN_INCOMING_REMOTE_: false
76+
run: |
77+
options(crayon.enabled = TRUE)
78+
rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
79+
shell: Rscript {0}
80+
81+
- name: Upload check results
82+
if: failure()
83+
uses: actions/upload-artifact@main
84+
with:
85+
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
86+
path: check

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.Rproj.user
2+
.Rprofile

DESCRIPTION

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Package: mlr3torch
2+
Title: What the Package Does (One Line, Title Case)
3+
Version: 0.0.0.9000
4+
Authors@R:
5+
person(given = "Lukas",
6+
family = "Burk",
7+
role = c("aut", "cre"),
8+
email = "[email protected]",
9+
comment = c(ORCID = "0000-0001-7528-3795"))
10+
Description: What the package does (one paragraph).
11+
License: MIT + file LICENSE
12+
Encoding: UTF-8
13+
LazyData: true
14+
Roxygen: list(markdown = TRUE)
15+
RoxygenNote: 7.1.1
16+
Imports:
17+
lifecycle

NAMESPACE

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Generated by roxygen2: do not edit by hand
2+

NEWS.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# mlr3torch 0.0.0.9000
2+
3+
* Added a `NEWS.md` file to track changes to the package.

R/mlr3torch-package.R

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#' @keywords internal
2+
"_PACKAGE"
3+
4+
# The following block is used by usethis to automatically manage
5+
# roxygen namespace tags. Modify with care!
6+
## usethis namespace: start
7+
## usethis namespace: end
8+
NULL

README.Rmd

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
output: github_document
3+
---
4+
5+
<!-- README.md is generated from README.Rmd. Please edit that file -->
6+
7+
```{r, include = FALSE}
8+
knitr::opts_chunk$set(
9+
collapse = TRUE,
10+
comment = "#>",
11+
fig.path = "man/figures/README-",
12+
out.width = "100%"
13+
)
14+
```
15+
16+
# mlr3torch
17+
18+
<!-- badges: start -->
19+
<!-- badges: end -->
20+
21+
The goal of {mlr3torch} is to connect [{mlr3}](https://github.com/mlr-org/mlr3) with [{torch}](https://github.com/mlverse/torch).
22+
23+
## Installation
24+
25+
<!-- You can install the released version of mlr3torch from [CRAN](https://CRAN.R-project.org) with: -->
26+
27+
<!-- ``` r -->
28+
<!-- install.packages("mlr3torch") -->
29+
<!-- ``` -->
30+
31+
```r
32+
remotes::install_github("jemus42/mlr3torch")
33+
```
34+
35+
36+
## Example
37+
38+
This is a basic example which shows you how to solve a common problem:
39+
40+
```{r example, eval=FALSE}
41+
library(mlr3torch)
42+
## basic example code
43+
```
44+

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
<!-- README.md is generated from README.Rmd. Please edit that file -->
3+
4+
# mlr3torch
5+
6+
<!-- badges: start -->
7+
<!-- badges: end -->
8+
9+
The goal of {mlr3torch} is to connect
10+
[{mlr3}](https://github.com/mlr-org/mlr3) with
11+
[{torch}](https://github.com/mlverse/torch).
12+
13+
## Installation
14+
15+
<!-- You can install the released version of mlr3torch from [CRAN](https://CRAN.R-project.org) with: -->
16+
<!-- ``` r -->
17+
<!-- install.packages("mlr3torch") -->
18+
<!-- ``` -->
19+
20+
``` r
21+
remotes::install_github("jemus42/mlr3torch")
22+
```
23+
24+
## Example
25+
26+
This is a basic example which shows you how to solve a common problem:
27+
28+
``` r
29+
library(mlr3torch)
30+
## basic example code
31+
```

man/figures/lifecycle-archived.svg

+1
Loading

man/figures/lifecycle-defunct.svg

+1
Loading

man/figures/lifecycle-deprecated.svg

+1
Loading
+1
Loading

man/figures/lifecycle-maturing.svg

+1
Loading

man/figures/lifecycle-questioning.svg

+1
Loading

man/figures/lifecycle-stable.svg

+1
Loading

man/figures/lifecycle-superseded.svg

+1
Loading

man/mlr3torch-package.Rd

+15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mlr3torch.Rproj

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Version: 1.0
2+
3+
RestoreWorkspace: No
4+
SaveWorkspace: No
5+
AlwaysSaveHistory: Default
6+
7+
EnableCodeIndexing: Yes
8+
UseSpacesForTab: Yes
9+
NumSpacesForTab: 2
10+
Encoding: UTF-8
11+
12+
RnwWeave: knitr
13+
LaTeX: XeLaTeX
14+
15+
AutoAppendNewline: Yes
16+
StripTrailingWhitespace: Yes
17+
LineEndingConversion: Posix
18+
19+
BuildType: Package
20+
PackageUseDevtools: Yes
21+
PackageInstallArgs: --no-multiarch --with-keep.source
22+
PackageRoxygenize: rd,collate,namespace

0 commit comments

Comments
 (0)