mlr-org / mlr-org/pkgsrc

Short intro and scope

Open
#2 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Hi @richfitz and @mllg

Very short introductions below.

Rich and I work at Imperial together. Rich has worked on many many R projects but most relevant here is provisionr and in particular the package_sources function for collecting info on package sources. But I believe Rich is planning on deprecating the function and/or package.

Michel is the main developer on the mlr3 project, which is our primary use-case for this package (though hope would generalise well).

Both very experienced in R6 and R programming in general but here we are looking at something that should be fairly simple and stripped back (S3 only).

This issue covers my motivation and some basic design ideas. Essentially I need a way of cleanly storing and querying package information for mlr3extralearners, which preferably includes package name and location.

At a minimum I think we need one function that can construct an S3 class that provides information about the package name and location. provisionr includes packages from github, cran, drat, local-- I think in addition we should include Bioconductor and release URLs.

We could also consider a separated class that holds all the packages that could be useful for install methods and printing.

Some links to another implementation by Michel to something similar to this: https://github.com/rdatsci/rtcl/blob/master/R/stringToPackage.r https://github.com/rdatsci/rtcl/blob/master/R/Packages.r https://github.com/rdatsci/rtcl/blob/master/R/installPackage.r

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading provisionr's R/package_sources.R and the linked mlr3 issue, then compare the related rtcl files: R/stringToPackage.r, R/Packages.r, and R/installPackage.r. Done means agreeing on an S3 representation that stores package name and location and covers the proposed package sources, including Bioconductor and release URLs.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.