external_tools_get_property_by_tool_name: external_tools_get_property_by_tool_name

View source: R/fct_external_tools_load_dataframe.R

external_tools_get_property_by_tool_nameR Documentation

external_tools_get_property_by_tool_name

Description

external_tools_get_property_by_tool_name

Usage

external_tools_get_property_by_tool_name(
  tool_name,
  property_to_retrieve,
  external_tools_df = external_tool_metadata
)

Arguments

tool_name

name of tool

property_to_retrieve

which property to retrieve. see details for options. (string)

external_tools_df

the dataframe to add tool metadata to. By default, will use global variable: GLOBAL_external_tools_dataframe

Details

Options for property_to_retrieve

  • tool_name

  • tool_id

  • tool_group

  • tool_class

  • tool_description

  • instructions

  • website

  • doi

  • requires_maf_export

  • requires_gene_selection

  • maf_conversion_function

  • extension

See ?external_tools_add_tool_to_dataframe for more info on these properties

run external_tool_metadata to see the built in tool metadata dataframe

Value

value of retrieved property (string)

Examples

CRUX:::external_tools_get_property_by_tool_name(tool_name = "OncodriveFML", "website")

CCICB/CRUX documentation built on Jan. 28, 2024, 10:12 p.m.