method_definition: Method information and introduction

View source: R/method_definition.R

method_definitionR Documentation

Method information and introduction

Description

Method information and introduction

Usage

method_definition(
  method,
  programming = NULL,
  url = NULL,
  authors = list(),
  manuscript = list(),
  description = NULL,
  vignette = NULL
)

Arguments

method

Method name.

programming

Programming language.

url

Relative website URL.

authors

Methods creator.

manuscript

Manuscript information.

description

Descriptions to the method.

vignette

The URL of method vignette

Value

A list.

See Also

authors_definition(), manuscript_definition()

Examples

a <- method_definition(
method = "A",
programming = "Python",
url = "www.xxxx.com",
authors = authors_definition(first = "Hongrui",
                             last = "Duo",
                             email = "duohongrui@cqnu.edu.cn",
                             github = "https://github.com/duohongrui",
                             orcid = "0000-0001-8683-015X"),
manuscript = manuscript_definition(title = "xxxxx",
                                   doi = "xxxxxx",
                                   journal = "xxxxx",
                                   date = "2022",
                                   peer_review = TRUE),
description = "xxxxxx")

duohongrui/simutils documentation built on March 12, 2024, 8:40 p.m.