def_method {dynwrap}R Documentation

Define meta information on the TI method.

Description

Define meta information on the TI method.

Usage

def_method(
  id,
  name = id,
  source = "tool",
  tool_id = NULL,
  platform = NULL,
  url = NULL,
  license = NULL,
  authors = list(),
  description = NULL
)

Arguments

id

An id by which to identify a method. Should only contain lowercase letters or underscores.

name

The name of the method.

source

The type of TI method. Options are :

  • "tool": a published TI method (peer-reviewed or preprint) (default),

  • "adaptation": an adaptation of a published method,

  • "offtheshelf": a method constructed from off-the-shelf algorithms,

  • "control": a control TI method (so not actually a TI method).

tool_id

If there are multiple TI methods from the same toolkit, the name of the toolkit can be specified here.

platform

The platform the TI method uses (e.g. R, Python, C++, ...).

url

An URL to the codebase of the method.

license

The software license the method uses (e.g. GPL-3, BSD-3, Artistic-2.0, MIT).

authors

A list of authors (see example).

description

Additional information on the method

Examples

def_method(
  id = "some_method",
  name = "Some method <3",
  source = "tool",
  tool_id = "bobstoolkit",
  platform = "VBA",
  url = "https://github.com/bobdylan/singlecellvba",
  license = "GPL-3",
  authors = list(
    def_author(
      given = "Bob",
      family = "Dylan",
      email = "bob@dylan.com",
      github = "bobdylan",
      orcid = "0000-0003-1234-5678"
    )
  ),
  description = "I love trajectories!!"
)

[Package dynwrap version 1.2.2 Index]