# General

# Definitions

**Annotations:**<span style="font-weight: 400;"> Data describing the gene models, pathways, ontologies, and other relevant biological information. Annotations are always associated with a reference genome and are consumed during a command execution through the argument or input variables.</span>

**Argument(s):** <span style="font-weight: 400;">Parameter variables that are defined with a key-value pair (</span>*<span style="font-weight: 400;">Example: --Threads 10</span>*<span style="font-weight: 400;">). Arguments are used by the tools during command building.</span>

**Command:**<span style="font-weight: 400;"> Fundamental unit of a tool that executes a specific job.</span>

**Data Store:**<span style="font-weight: 400;"> Stores all data types uploaded into the user's account. The data store is subdivided (sequence data, references, annotations, and metadata) for easy access.</span>

**Execution Flow:**<span style="font-weight: 400;"> Displays the list of tools in the execution order</span>

**FileList:**<span style="font-weight: 400;"> List of files used by a tool/command</span>

**File:**<span style="font-weight: 400;"> A single file used by a tool/command</span>

**Metadata:**<span style="font-weight: 400;"> Data that describes an experiment. Metadata is used for data analysis through the options, argument, or input variables.</span>

**Merge Step:**<span style="font-weight: 400;"> A step in a pipeline that merges all the input files into a single output file.</span>

**My Pipelines:**<span style="font-weight: 400;"> Pipelines shown within a project. Pipelines can be copied from the Pipeline Library into a project.</span>

**Hub:**<span style="font-weight: 400;"> Pipelines are grouped into categories (Hub) based on function.</span>

**Input(s):** <span style="font-weight: 400;">Any data files used in a command. These are either uploaded by the user or generated within an executed job.</span>

**Jobs:**<span style="font-weight: 400;"> Each execution of a pipeline is designated with a job ID.</span>

**Option(s):**<span style="font-weight: 400;"> Command parameters that are defined with a single word (</span>*<span style="font-weight: 400;">Example: --ignore</span>*<span style="font-weight: 400;">). These are used by the tools while command building.</span>

**Output(s):** <span style="font-weight: 400;">Data files created during pipeline execution.</span>

**Pipeline:**<span style="font-weight: 400;"> A set of computational tools, which run either sequentially or parallelly in order to achieve a specific data analysis objective. Tools/commands are designated as steps in a pipeline.</span>

**Pipeline Library:**<span style="font-weight: 400;"> The list of pre-configured pipelines available on the platform</span>

**Projects:** <span style="font-weight: 400;">Self-contained mini-workspaces, where sample sets can be analyzed independently without interference from other data, using multiple pipelines.</span>

**Reports:**<span style="font-weight: 400;"> Results of a pipeline execution are aggregated into easily understandable formats for quick viewing.</span>

**Sample Set:**<span style="font-weight: 400;"> A set of samples (cohort) selected within a project. Sample sets are used for data analysis.</span>

**Tool:**<span style="font-weight: 400;"> A bioinformatics software program that solves a specific biological problem. A tool can contain multiple commands (Example: Samtools index, sort)</span># Frequently Asked Questions

 **Who can use the Stanome platform?**

<span style="font-weight: 400;">Anyone who has NGS data to be analyzed can take advantage of the platform. The user does not need hardware resources or computational knowledge of NGS tools to use the Stanome platform.</span>

 **Which browsers and operating systems do I need to use to access the Stanome platform?**

<span style="font-weight: 400;">The platform is tested and validated on the latest versions of the Chrome browser and works best on any operating system that supports the Chrome browsers.</span>

 **How can I contact Stanome's technical support team?**

<span style="font-weight: 400;">Mail your detailed query to </span>[<span style="font-weight: 400;">support@stanome.com</span>](mailto:support@billionbases.com)<span style="font-weight: 400;">. </span>

 **How can I use my own custom reference genome?**

<span style="font-weight: 400;">Upload custom reference genomes through the </span>**Reference/Annotation files** <span style="font-weight: 400;">tab on the </span>**Upload**<span style="font-weight: 400;"> window. Refer to section 4.2 (Upload Reference and annotation files) for detailed instructions on how to upload custom reference and annotation files.</span>

 **How can I share my data with only my team members?**

<span style="font-weight: 400;">The multi-tenancy feature allows data sharing and analysis between group members of a shared account. Group members can request other members to join the group.</span>

 **Can I download analysis files and how?**

<span style="font-weight: 400;">Yes, analysis files can be downloaded through the Report section. Refer to section 7.5 (Reports) to learn more about accessing all the intermediate output/analysis files.</span>

 **Can I get a customized report?**

<span style="font-weight: 400;">Yes, a customized report with custom plots and tables can be obtained upon request. Contact Stanome technical support team (</span>[<span style="font-weight: 400;">support@stanome.com</span>](mailto:support@billionbases.com)<span style="font-weight: 400;">) with details of the requirement.</span>

 **How do I troubleshoot my failed pipeline?**

<span style="font-weight: 400;">Check your mail with the job status update. Issues related to the input data are described in the mail. Contact Stanome technical support team along with the job ID, if you are still not able to troubleshoot the issue.</span>

 **Can I build a command that only generates standard output?**

<span style="font-weight: 400;">Yes, a command could be built using the </span>**Command builder**<span style="font-weight: 400;"> dialog box within a pipeline. However, its output could be found in the output.log on the “sample deep dive” page described in section 7.4. In order to redirect the output to the next step in the pipeline contact the Stanome technical support team with details of the requirement.</span>

 **How can I delete the data completely from the platform?**

<span style="font-weight: 400;">Raw sequence data can be deleted from the </span>**Sequence Data**<span style="font-weight: 400;"> window (Utilities Menu). Analysis data can be deleted from the </span>**Projects**<span style="font-weight: 400;"> window.</span>

**How long is the data retained?**

<span style="font-weight: 400;">Unless requested, all the data is purged after 30 days.</span>

**Why do I see duplicated pipelines?**

<span style="font-weight: 400;">Duplicate object names are not allowed on the platform. However, in a multi-tenancy setup, it’s allowed to create pipelines with the same names between shared users. Please use the owner tag to filter user-specific pipelines.</span>

**Are Stanome configured pipelines allowed to add to the favorites?**

<span style="font-weight: 400;">Stanome configured pipelines are accessible for all the users on the platform. These pipelines can’t be added to the favorites but can be copied into your projects.</span>

**Why the header line required in the BED files?**

<span style="font-weight: 400;">The BED file format is adapted from</span>[<span style="font-weight: 400;"> the UCSC </span><span style="font-weight: 400;">https://genome.ucsc.edu/FAQ/FAQformat.html</span>](https://genome.ucsc.edu/FAQ/FAQformat.html)<span style="font-weight: 400;">. We certify and validate the BED files against the reference genomes. Though header is not generally required, Stanome uses the header (</span>*<span style="font-weight: 400;">track name#</span>*<span style="font-weight: 400;">) content for the Genome Browser visualization in Stanome Report.</span># Quick Start Guide

This is a shorter version of the user guide that helps the users to get familiar with the platform quickly.

# Steps to perform your first analysis

**Step 1 :** Upload samples and other required files through "[Uploader](https://docs.stanome.com/books/uploader)". Each file will go through the validation process. Check the [DataStore](https://docs.stanome.com/books/data-store) to verify the status of the uploaded files.

**Step 2 :** Create yours first project using [Projects](https://docs.stanome.com/books/project-management/page/project-setup) from the left menu.

**Step 3 :** Inside the project, create a [Sample Set ](https://docs.stanome.com/books/project-management/page/sample-set-management)from the [DataStore](https://docs.stanome.com/books/data-store).

**Step 4:** Create a new pipeline or copy a preconfigured pipeline from the PipelineLibrary ([My Pipelines](https://docs.stanome.com/books/project-management/page/pipeline-creation)).

**Step 5:** Execute the pipeline by clicking the [Initialize Pipeline](https://docs.stanome.com/books/project-management/page/pipeline-execution) button. Fill in the required fields and click "Execute Pipeline".

**Step 6:** Monitor pipeline execution progress through [Jobs](https://docs.stanome.com/books/project-management/page/jobs).

**Step 7:** After the run completion, [Report](https://docs.stanome.com/books/project-management/page/overview) is ready to reviewed.

# Customisation

Adding a New Organism  
Click on settings icon [![image-1690128218765.png](https://docs.stanome.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690128218765.png)](https://docs.stanome.com/uploads/images/gallery/2023-07/image-1690128218765.png) from the right upper corner. Select [![image-1690128380323.png](https://docs.stanome.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690128380323.png)](https://docs.stanome.com/uploads/images/gallery/2023-07/image-1690128380323.png) from the left menu bar. Create a new organism by clicking [![image-1690128593563.png](https://docs.stanome.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690128593563.png)](https://docs.stanome.com/uploads/images/gallery/2023-07/image-1690128593563.png) icon. Fill in the required information and click [![image-1690128725265.png](https://docs.stanome.com/uploads/images/gallery/2023-07/scaled-1680-/image-1690128725265.png)](https://docs.stanome.com/uploads/images/gallery/2023-07/image-1690128725265.png)icon to save it.

