Copies the example files bundled inside the package's internal
shinyapp/ directory into the user's current working directory.
This helper function is designed for new users who want to quickly review the protocol and example dataset metadata before running the Genomic DB Browser manually.
It copies:
The datasets/ folder (including all example datasets),
Datasets infomation.xlsx (example dataset information index),
Use protocol.docx (step-by-step usage guide).
These files help new users understand:
How dataset metadata should be formatted,
How to fill in Datasets infomation.xlsx for their own datasets,
The recommended workflow described in the protocol.
xzdb.help()Invisibly returns the paths of the copied files.
After running this function, your working directory will contain:
A local copy of the datasets/ folder,
The example dataset information Excel file,
A protocol document explaining how to structure and use the database.
You can modify Datasets infomation.xlsx to include your own datasets:
Open the file in Excel.
Add a new row for each dataset you want to index.
Set DatasetName to the exact filename (e.g., "MyData.xlsx").
Set the sheet number/name in the Sheet column.
Save the file in the same folder.
When you run the Shiny application, the program will automatically read this Excel file to index and process your datasets.
if (FALSE) { # \dontrun{
# Prepare example data and protocol files in the current folder
xzdb.help()
# After this, check your working directory:
# datasets/
# Datasets infomation.xlsx
# Use protocol.docx
} # }