print_info: Simer information

View source: R/simer.Utility.R

print_infoR Documentation

Description

Print R Package information, include title, short_title, logo, version, authors, contact.

Usage

print_info(
  welcome = NULL,
  title = NULL,
  short_title = NULL,
  logo = NULL,
  version = NULL,
  authors = NULL,
  contact = NULL,
  linechar = "=",
  width = NULL,
  verbose = TRUE
)

Arguments

welcome

welcome text, for example: "Welcom to <Packagename>".

title

long text to introduct package.

short_title

short label, top-left of logo.

logo.

version

short label, bottom-right of logo.

authors

authors of software.

contact

email or website.

linechar

1, 2, or char.

width

banner width.

verbose

whether to print detail.

Details

Build date: Oct 22, 2018 Last update: Apr 30, 2022

Value

welcome information.

Author(s)

Dong Yin and Haohao Zhang

Examples

welcome <- "Welcome to SIMER"
title   <- "Data Simulation for Life Science and Breeding"
authors <- c("Designed and Maintained by Dong Yin, Xuanning Zhang,
              Lilin Yin, Haohao Zhang, and Xiaolei Liu", 
             "Contributors: Zhenshuang Tang, Jingya Xu, Xinyun Li, 
              Mengjin Zhu, Xiaohui Yuan, Shuhong Zhao")
contact <- "Contact: xiaoleiliu@mail.hzau.edu.cn"
logo_s  <- c(" ____ ___ __  __ _____ ____  ", 
             "/ ___|_ _|  \\/  | ____|  _ \\ ", 
             "\\___ \\| || |\\/| |  _| | |_) |", 
             " ___) | || |  | | |___|  _ < ", 
             "|____/___|_|  |_|_____|_| \\_\\")
print_info(welcome = welcome, title = title, logo = logo_s, authors = authors, 
           contact = contact, linechar = '=', width = 70)

simer documentation built on April 3, 2025, 9:24 p.m.