luckyModel

Model ensemble for third-party lucky series, such GSClassifier

👽 Authors

Weibin Huang (黄伟斌); [email protected]

1. Guangdong Provincial Key Laboratory of Digestive Cancer Research, The Seventh Affiliated Hospital of Sun Yat-sen University, No. 628 Zhenyuan Road, Shenzhen, 518107, Guangdong, China.

2. Department of Gastrointestinal Surgery, The First Affiliated Hospital of Sun Yat-sen University, 58 Zhongshan 2nd Road, Guangzhou 510080, Guangdong, People’s Republic of China.

👍 Installaton

# Install "devtools" package
if (!requireNamespace("devtools", quietly = TRUE))
    install.packages("devtools")
    
# Install luckyModel
if (!requireNamespace("luckyModel", quietly = TRUE))
    devtools::install_github("huangwb8/luckyModel")

🌱 Common usage

Load the pacakge

library(luckyModel)

Which projects were supported in current luckyModel?

list_project()

## [1] "GSClassifier"

Explore models in a project, just:

list_model(project='GSClassifier')

## Available models in GSClassifier:

##   *Gibbs_PanCancerImmuneSubtype_v20190731
##   *hwb_PAD_v20200110
##   *HWB_PAD_v20220916
##   *HWB_PAD_v20250523

Calling a specific model, just:

model <- lucky_model(project = 'GSClassifier',
                    developer='HWB',
                    model = 'PAD',
                    version = 'v20250523')
names(model)

## [1] "ens"            "scaller"        "geneAnnotation" "geneSet"

Contribute your model

• Fork luckyModel and make sure you can do somethings like clone, commit, and push.

• Save your model in the local repository of the luckyModel package (The same path of README.md).

save_model(x = <Your model>,
           model.path = <local repository>,
           project = <Your project name>,
           model = <Your model name>,
           developer = <Your name>,
           version = <Your model version>)

• Push to your branch

• Merge to master after audit