Skip to content

Commit

Permalink
fix docu and readme, remove appveyor
Browse files Browse the repository at this point in the history
  • Loading branch information
giuseppec committed Feb 24, 2018
1 parent 47ca496 commit 37dd6ae
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 69 deletions.
4 changes: 2 additions & 2 deletions 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.
Expand Down
19 changes: 11 additions & 8 deletions 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.

Expand Down
57 changes: 0 additions & 57 deletions appveyor.yml

This file was deleted.

4 changes: 2 additions & 2 deletions man/extractOMLStudyIds.Rd

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

0 comments on commit 37dd6ae

Please sign in to comment.