astrocyte_pkg.yml 6.73 KB
Newer Older
David Trudgian's avatar
David Trudgian committed
1 2 3 4 5 6 7 8 9 10 11
#
# metadata for the example astrocyte ChipSeq workflow package
#

# -----------------------------------------------------------------------------
# BASIC INFORMATION
# -----------------------------------------------------------------------------

# A unique identifier for the workflow package, text/underscores only
name: 'example_wordcount'
# Who wrote this?
PLian's avatar
PLian committed
12
author: 'David Trudgian, Peng Lian'
David Trudgian's avatar
David Trudgian committed
13 14 15 16 17 18 19 20
# A contact email address for questions
email: 'biohpc-help@utsouthwestern.edu'
# A more informative title for the workflow package
title: 'Example Wordcount Workflow'
# A summary of the workflow package in plain text
description: |
  This is a minimal test workflow package that counts the occurences of words
  in a test file. It can be used as a template to develop workflows, and as to
PLian's avatar
PLian committed
21 22 23
  test the astrocyte platform. Please note that start from publish version 
  0.0.8 and test version 0.0.2, this workflow will only support Astrocyte 0.4.0
  and above.
David Trudgian's avatar
David Trudgian committed
24

PLian's avatar
PLian committed
25 26 27 28 29 30 31
#### New Features in Astrocyte 0.4.0 and above ####
citation: |
  Please cite individual programs and versions of pipeline
  used, and the overall pipeline doi: 12.3456/zenodo.9876543.
  Please cite in publications:
  Pipeline was developed by BioHPC.
  
32 33 34 35 36 37
# The minimum Astrocyte version that requires to run this workflow. For old pipelines, which do not have this label 
# a default value of 0.3.1 will be assigned automatically. A request of minimum version less than 0.4.0 will be ignored.
minimum_astrocyte_version: '0.4.0'
# The Nextflow version that requires to run this workflow.  For old pipelines, which do not have this label 
# a default value of 0.31.0 will be assigned automatically. Please make sure the requested nextflow version is available
# in the module list.
PLian's avatar
PLian committed
38 39 40
nextflow_version: '20.01.0'
# (Optional) The Nextflow config file to use for this workflow. If provided, the file should exist in workflow/configs
nextflow_config: 'biohpc.config'
PLian's avatar
PLian committed
41
# The container to use for this workflow, none/singularity. If omitted, the default value 'none' will be used.
PLian's avatar
PLian committed
42 43 44 45
container: 'singularity'
# The version of singularity to use. This is required if container == 'singularity'
singularity_version: '3.5.3'

David Trudgian's avatar
David Trudgian committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
# -----------------------------------------------------------------------------
# DOCUMENTATION
# -----------------------------------------------------------------------------

# A list of documentation file in .md format that should be viewable from the
# web interface. These files are in the 'docs' subdirectory. The first file
# listed will be used as a documentation index and is index.md by convention
# To supply a title for documentation use a pair of [ 'filename', 'title' ]

documentation_files:
  - [ 'index.md', 'Wordcount Help' ]

# -----------------------------------------------------------------------------
# NEXTFLOW WORKFLOW CONFIGURATION
# -----------------------------------------------------------------------------

# Remember - The workflow file is always named 'workflow/main.f'
#            The workflow must publish all final output into $baseDir

# A list of clueter environment modules that this workflow requires to run.
# Specify versioned module names to ensure reproducability.
workflow_modules:
  - Test

# A list of parameters used by the workflow, defining how to present them,
# options etc in the web interface. For each parameter:
#
# REQUIRED INFORMATION
#  id:         The name of the parameter in the NEXTFLOW workflow
#  type:       The type of the parameter, one of:
76 77 78 79 80 81 82
#                string      - A free-format string
#                integer     - An integer
#                real        - A real number
#                file        - A single file from user data
#                files       - One or more files from user data
#                select      - A selection from a list of values
#                multiselect - One or more selections from a list of values
David Trudgian's avatar
David Trudgian committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
#  required:    true/false, must the parameter be entered/chosen?
#  description: A user friendly description of the meaning of the parameter
#
# OPTIONAL INFORMATION
#  default:   A default value for the parameter (optional)
#  min:       Minium value/characters/files for number/string/files types
#  max:       Maxumum value/characters/files for number/string/files types
#  regex:     A regular expression that describes valid entries / filenames
#
# SELECT TYPE
#  choices:   A set of choices presented to the user for the parameter.
#             Each choice is a pair of value and description, e.g.
# 
#             choices:
#               - [ 'myval', 'The first option']
#               - [ 'myval', 'The second option']
#
# NOTE - All parameters are passed to NEXTFLOW as strings... but they
#        are validated by astrocyte using the information provided above

workflow_parameters:

  - id: story
    type: files
    required: true
    description: |
      A text file containing a story
    regex: ".*(txt)"
    min: 1

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  - id: test_int
    type: integer
    required: true
    default: 123
    min: 1
    max: 1000
    description: |
      This is an example integer field, it is not used by the workflow

  - id: test_real
    type: real
    required: true
    default: 123.456
    min: 1
    max: 1000
    description: |
      This is an example real field, it is not used by the workflow
David Trudgian's avatar
David Trudgian committed
130

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
  - id: test_string
    type: string
    required: true
    default: "Example"
    description: |
      This is an example string field, it is not used by the workflow

  - id: test_select
    type: select
    required: true
    default: "Dog"
    description: |
      This is an example select field, it is not used by the workflow
    choices:
      - [ 'Cat', 'Cat, Kitten' ]
      - [ 'Dog', 'Dog, Puppy' ]
      - [ 'Horse', 'Horse, Foal' ]

  - id: test_multiselect
    type: multiselect
    required: true
    default: "Banana"
    description: |
      This is an example multiselect field, it is not used by the workflow
    choices:
      - [ 'Apple', 'Green Apple' ]
      - [ 'Banana', 'Yellow Banana' ]
      - [ 'Strawberry', 'Red Strawberry' ]
David Trudgian's avatar
David Trudgian committed
159 160 161 162 163 164 165 166 167

# -----------------------------------------------------------------------------
# SHINY APP CONFIGURATION
# -----------------------------------------------------------------------------

# Remember - The vizapp is always 'vizapp/server.R' 'vizapp/ui.R'
#            The workflow must publish all final output into $baseDir

# Name of the R module that the vizapp will run against
168
vizapp_r_module: 'R/3.4.1-gccmkl'
David Trudgian's avatar
David Trudgian committed
169 170 171 172 173 174 175 176 177 178

# List of any CRAN packages, not provided by the modules, that must be made
# available to the vizapp
vizapp_cran_packages:
  - shiny
  - shinyFiles

# # List of any Bioconductor packages, not provided by the modules, that must be made
# available to the vizapp
vizapp_bioc_packages:
179 180 181 182 183 184 185 186 187 188
  -

# # List of any packages to install from GitHub using devtools, that must be
# made availavle to the vizapp
vizapp_github_packages:
  -