diff --git a/R/extractOMLStudyIds.R b/R/extractOMLStudyIds.R index 2bb2c3c..e82dc8e 100644 --- a/R/extractOMLStudyIds.R +++ b/R/extractOMLStudyIds.R @@ -1,9 +1,9 @@ #' @title Extract IDs of a OMLStudy object #' #' @description -#' Extracts either all \code{data.id}s, \code{task.id}s, \code{flow.id}s or \code{run.id}s from an \code{\link{OMLStudy}} object. +#' Extracts either all \code{data.id}s, \code{task.id}s, \code{flow.id}s or \code{run.id}s from an \code{OMLStudy} object. #' -#' @param object [\code{\link{OMLStudy}}] \cr +#' @param object [\code{OMLStudy}] \cr #' The OMLStudy object. #' @param type [\code{character(1)}] \cr #' A character that specifies which ids should be extracted from the study. diff --git a/README.md b/README.md index 6e46b43..b2efcf1 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ -# R interface to [OpenML](http://www.openml.org/) +# R interface to [OpenML.org](http://www.openml.org/) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![CRAN Status Badge](http://www.r-pkg.org/badges/version/OpenML)](http://cran.r-project.org/web/packages/OpenML) -[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/OpenML)](http://cran.rstudio.com/web/packages/OpenML/index.html) [![Build Status](https://travis-ci.org/openml/openml-r.svg?branch=master)](https://travis-ci.org/openml/openml-r) -[![Build status](https://ci.appveyor.com/api/projects/status/mevevtyr538faqdv/branch/master?svg=true)](https://ci.appveyor.com/project/jakobbossek/openml-r/branch/master) +[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/OpenML)](http://cran.rstudio.com/web/packages/OpenML/index.html) [![codecov](https://codecov.io/gh/openml/openml-r/branch/master/graph/badge.svg)](https://codecov.io/gh/openml/openml-r) -[![Chat on slack](https://img.shields.io/badge/chat-on%20slack-yellow.svg)](https://openml.slack.com/messages/C289V36JG) -[OpenML](http://www.openml.org/frontend/page/home) is an online machine learning platform where researchers can access open data, download and upload data sets, share their machine learning tasks and experiments and organize them online to work and collaborate with other researchers. -The R interface allows to query for data sets with specific properties, and allows the downloading and uploading of data sets, tasks, flows and runs. See [OpenML API Guide](https://www.openml.org/guide/api) for more information. -This R package allows to interface the [OpenML](http://www.openml.org/frontend/page/home) server to download data sets, tasks, runs and upload results (see [Tutorial](http://openml.github.io/openml-r) or [Cheatsheet](https://github.com/openml/openml-r/blob/master/vignettes/openml-cheatsheet.pdf)). +[OpenML.org](http://www.openml.org/frontend/page/home) is an online machine learning platform where researchers can access open data, download and upload data sets, share their machine learning tasks and experiments and organize them online to work and collaborate with other researchers. +The R interface allows to query for data sets with specific properties, and allows the downloading and uploading of data sets, tasks, flows and runs. + +For more information, see +- [R Cheatsheet](https://github.com/openml/openml-r/blob/master/vignettes/openml-cheatsheet.pdf) +- [R Tutorial](http://openml.github.io/openml-r) +- [OpenML R Package Paper](http://dx.doi.org/10.1007/s00180-017-0742-2) +- [OpenML API Guide](https://www.openml.org/guide/api) # How to cite -To cite the OpenML R package in publications, please use our paper entitled [`OpenML`: An `R` Package to Connect to the Machine Learning Platform `OpenML`](http://dx.doi.org/10.1007/s00180-017-0742-2). You can also [download the Bibtex file.](https://citation-needed.springer.com/v2/references/10.1007/s00180-017-0742-2?format=bibtex&flavour=citation). +To cite the OpenML R package in publications, please use our paper entitled [`OpenML`: An `R` Package to Connect to the Machine Learning Platform `OpenML`](http://dx.doi.org/10.1007/s00180-017-0742-2). [[bibtex](https://citation-needed.springer.com/v2/references/10.1007/s00180-017-0742-2?format=bibtex&flavour=citation)]. See also [here](https://www.openml.org/cite) for further information on how to cite the OpenML project itself. diff --git a/appveyor.yml b/appveyor.yml deleted file mode 100644 index 5334056..0000000 --- a/appveyor.yml +++ /dev/null @@ -1,57 +0,0 @@ -init: - ps: | - $ErrorActionPreference = "Stop" - Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1" - Import-Module '..\appveyor-tool.ps1' - -install: - ps: Bootstrap - -cache: - - C:\RLibrary - -environment: - global: - R_ARCH: x64 - USE_RTOOLS: true - WARNINGS_ARE_ERRORS: 1 - - OPENMLAPIKEY: - secure: kZ2t27KjMTnsE9n5nfVJz1Bz42uKHr1R3KLN+DeZpdWkSvKd5dnu2NaJt9uFC1Xd - - matrix: - - R_VERSION: devel - - R_VERSION: release - - R_VERSION: oldrel - -build_script: - - travis-tool.sh install_deps - - travis-tool.sh github_package mlr-org/farff mlr-org/mlr berndbischl/BBmisc berndbischl/ParamHelpers - -before_test: - - Rscript -e 'dir.create(path.expand("~/.openml"));file.create(path.expand("~/.openml/config"))' - -test_script: - - travis-tool.sh run_tests - -on_failure: - - travis-tool.sh dump_logs - -artifacts: - - path: '*.Rcheck\**\*.log' - name: Logs - - - path: '*.Rcheck\**\*.out' - name: Logs - - - path: '*.Rcheck\**\*.fail' - name: Logs - - - path: '*.Rcheck\**\*.Rout' - name: Logs - - - path: '\*_*.tar.gz' - name: Bits - - - path: '\*_*.zip' - name: Bits diff --git a/man/extractOMLStudyIds.Rd b/man/extractOMLStudyIds.Rd index 88566bd..33c296c 100644 --- a/man/extractOMLStudyIds.Rd +++ b/man/extractOMLStudyIds.Rd @@ -7,7 +7,7 @@ extractOMLStudyIds(object, type) } \arguments{ -\item{object}{[\code{\link{OMLStudy}}] \cr +\item{object}{[\code{OMLStudy}] \cr The OMLStudy object.} \item{type}{[\code{character(1)}] \cr @@ -18,5 +18,5 @@ Can be either "data.id", "task.id", "flow.id" or "run.id".} [\code{numeric}]. } \description{ -Extracts either all \code{data.id}s, \code{task.id}s, \code{flow.id}s or \code{run.id}s from an \code{\link{OMLStudy}} object. +Extracts either all \code{data.id}s, \code{task.id}s, \code{flow.id}s or \code{run.id}s from an \code{OMLStudy} object. }