Build an index file for one dataset

Reads a single dataset file located in the local datasets/ folder, extracts gene identifier and gene symbol columns, normalizes and resolves missing values, removes rows with no usable identifiers, and produces an index file.

The resulting index CSV is written to both locations:

1. Local: ./IndexedData/

2. Package: system.file("shinyapp", package = "XZDBfunction")/IndexedData/

If writing to the installed package directory is not permitted, the function writes locally without error and emits a warning.

xiaopei.input(
  file.Name,
  Sheet = 1,
  xlsx.index.location = "Datasets infomation.xlsx",
  write_to_shinyapp = TRUE
)

Arguments

file.Name

Character. Dataset filename (must exist under datasets/).

Sheet

Integer or character. Sheet number or sheet name when reading XLSX files. Default: 1.

xlsx.index.location

Character. Path to the Dataset Information Excel file (typically "Datasets infomation.xlsx"). Must exist in the current working directory, not inside the package.

write_to_shinyapp

Logical. Whether to write the index output into the package shinyapp/ directory in addition to the local IndexedData/ directory. Default: TRUE.

Value

Invisibly returns the tibble containing the processed index table. Primarily called for its side-effects (CSV file creation).

Details

The function uses the metadata in the index Excel file to:

• Determine the expected file type (CSV/TXT/XLSX)

• Locate gene identifier and gene symbol columns

• Normalize, trim, and resolve missing identifier pairs

• Construct stable row keys of the form "DatasetName~Sheet.index"

• Drop rows where both ID and Symbol cannot be recovered

Examples

if (FALSE) { # \dontrun{
xiaopei.input("DatasetA.xlsx", Sheet = 1)
} # }