Skip to contents

Get the parameters that were used.

get_params.Rd

Extracts parameters from the BixverseBaseClass class (or child classes) and has options to return (pretty) JSONs. This generic also gets inherited by other classes and can be used to extract parameters. Also, can dispatch to specific methods for certain S3 classes.

Usage

get_params(object, to_json = FALSE, pretty_json = FALSE)

get_params.Hotspot(object, to_json = FALSE, pretty_json = FALSE)

get_params.miloR(object, to_json = FALSE, pretty_json = FALSE)

get_params.ScenicGrn(object, to_json = FALSE, pretty_json = FALSE)

Arguments

object

A class within bixverse that inherits from BixverseBaseClass() or defined S3 classes.

to_json

Shall the params be returned as a JSON string.

pretty_json

Shall the params be returned as a pretty JSON string.

Value

Depending on parameters either the R list or a (pretty) JSON string.