OpenStatsReport: Method "OpenStatsReport"

In mpi2/OpenStats: A Robust and Scalable Software Package for Reproducible Analysis of High-Throughput genotype-phenotype association

Method "OpenStatsReport"

Description

Wrapper for the output of 'OpenStatsAnalysis'. Returns model fitting and results in a list or JSON format (StatPacket).

Usage

OpenStatsReport(
	object                   ,
	othercolumns = NULL      ,
	JSON = FALSE             ,
	RemoveNullKeys = FALSE   ,
	ReportNullSchema = FALSE ,
	...
)

Arguments

object	'Mandatory argument'. An instance of the OpenStatsAnalysis result object
othercolumns	A list of column names that must be included in the results. Default NULL
JSON	Logical flag. Setting to TRUE for the JSON (StatPacket) output otherwise, the function returns a list
RemoveNullKeys	Logical flag. Setting to TRUE will remove all NULL elements from the output. Default is FALSE
ReportNullSchema	logical flag. Setting to TRUE forces the function to return results even if the OpenStatsAnalysis returns a failure message
...	Other parameters that can be passed to 'toJSON()' function in the "jsonlite" library

Details

OpenStatsReport function can be used to extract the key elements of the analysis from the OpenStatsMM/FE/RR objects (the output from OpenStatsAnalysis function). The output from OpenStatsReport has schemed that makes it easy to be populated to the downstream processes such as storing and accessing results from a database.

Value

A list of values or a JSON object depends on the "JSON" parameter

Author(s)

Hamed Haseli Mashhadi <[e-mail]>

See Also

OpenStatsAnalysis

Examples

example(OpenStatsAnalysis)

mpi2/OpenStats documentation built on Sept. 17, 2022, 3:58 p.m.