Version Info

R version: R version 4.4.0 RC (2024-04-16 r86468)

Bioconductor version: 3.19

Package version: 1.13.0

Introduction

ExpHunterSuite implements a comprehensive protocol for the analysis of transcriptional data using established R packages and combining their results. It covers all key steps in DEG detection, CEG detection and functional analysis for RNA-seq data. It has been implemented as an R package containing functions that can be run interactively. In addition, it also contains scripts that wrap the functions and can be run directly from the command line.

#Standard Package Usage

In this section we will describe how the functions in ExpHunterSuite can be used interactively or joined together in user-written scripts. We will also describe how the output reports can be generated from this data.

Differential Expression Analysis

The most basic use of the package is to perform differential expression (DE) gene analysis. ExpHunterSuite will, following some initial preprocessing, run the different methods, combine the results, and produce an output report, as well as a single output table containing the results of all of the methods used, and their combined scores. The combined scores consist of the mean logFC value and the combined adjusted p-value (FDR) values, calculated by Fishers method.

To use ExpHunterSuite with only a single DE package, one can run the following command:

library(ExpHunterSuite)
data(toc)
data(target)
degh_out_one_pack <- main_degenes_Hunter(raw=toc, 
                                         target=target,
                                         modules="D") # D for DESeq2

Where toc is a data.frame of aligned reads per samples and target is a data.frame relating each sample to its sample meta data. Here we include a minimal example of the target file whcih includes the samples (CTL/epm2a), the samples condition (Ctrl or Treat):

head(toc)
##                    CTL_1 CTL_2 CTL_3 CTL_4 epm2a_1 epm2a_2 epm2a_3
## ENSMUSG00000102693     0     0     0     0       0       0       0
## ENSMUSG00000064842     0     0     0     0       0       0       0
## ENSMUSG00000051951   497   687   645   585     563     533     478
## ENSMUSG00000102851     0     0     0     0       0       0       0
## ENSMUSG00000103377     0     0     0     0       1       1       2
## ENSMUSG00000104017     0     2     0     0       0       4       0
head(target)
##    sample treat
## 1   CTL_1  Ctrl
## 2   CTL_2  Ctrl
## 3   CTL_3  Ctrl
## 4   CTL_4  Ctrl
## 5 epm2a_1 Treat
## 6 epm2a_2 Treat

The files containing this data are contained within the extData package directory and can be accessed in the following manner. We will come back to them in the section on command line usage.

system.file("extData", "table_of_counts.txt", package = "ExpHunterSuite")
## [1] "/tmp/Rtmptd5Enj/Rinst25f466526c3443/ExpHunterSuite/extData/table_of_counts.txt"
system.file("extData", "target.txt", package = "ExpHunterSuite")
## [1] "/tmp/Rtmptd5Enj/Rinst25f466526c3443/ExpHunterSuite/extData/target.txt"

To use it with multiple packages, one can run the following command:

degh_out_multi_pack <- main_degenes_Hunter(raw=toc, 
                                    target=target, 
                                    modules="DEL") # D:DESeq2 E:EdgeR, L:limma

The output is a list, which includes, in slot DE_all_genes a data.frame containing, for each gene, logFC/p-values/adjusted p-values for the different DE methods implemented:

head(degh_out_multi_pack$DE_all_genes)
##                    logFC_DESeq2    FDR_DESeq2 pvalue_DESeq2 logFC_edgeR
## ENSMUSG00000055493    -4.762721 1.621389e-131 6.841303e-134   -4.707185
## ENSMUSG00000026822     7.163151  2.054983e-86  2.601244e-88    7.171445
## ENSMUSG00000024164     3.941761 2.820463e-128 2.380137e-130    3.984540
## ENSMUSG00000097971     2.377971  8.318050e-84  1.403890e-85    2.422976
## ENSMUSG00000034855     4.460555  2.184106e-19  1.474502e-20    4.485882
## ENSMUSG00000069516     2.428258  6.232232e-61  1.314817e-62    2.476535
##                        FDR_edgeR  pvalue_edgeR logFC_limma    FDR_limma
## ENSMUSG00000055493 1.044257e-207 8.812294e-210   -4.695295 5.079109e-08
## ENSMUSG00000026822 2.664949e-237 1.124451e-239    7.613741 7.533045e-06
## ENSMUSG00000024164 3.806399e-131 4.818227e-133    3.987732 8.916977e-07
## ENSMUSG00000097971  2.984579e-90  6.296579e-92    2.416537 4.914712e-07
## ENSMUSG00000034855 5.770358e-126 9.739002e-128    4.776115 8.879106e-06
## ENSMUSG00000069516  2.536675e-65  6.421961e-67    2.463295 4.234716e-06
##                    pvalue_limma DESeq2_DEG edgeR_DEG limma_DEG DEG_counts
## ENSMUSG00000055493 2.143084e-10       TRUE      TRUE      TRUE          3
## ENSMUSG00000026822 4.132050e-07       TRUE      TRUE      TRUE          3
## ENSMUSG00000024164 1.504975e-08       TRUE      TRUE      TRUE          3
## ENSMUSG00000097971 4.147437e-09       TRUE      TRUE      TRUE          3
## ENSMUSG00000034855 5.619687e-07       TRUE      TRUE      TRUE          3
## ENSMUSG00000069516 1.923696e-07       TRUE      TRUE      TRUE          3
##                     combined_FDR FDR_labeling mean_logFCs     genes_tag
## ENSMUSG00000055493  0.000000e+00         SIGN   -4.721734 PREVALENT_DEG
## ENSMUSG00000026822 1.185758e-322         SIGN    7.316113 PREVALENT_DEG
## ENSMUSG00000024164 1.774813e-259         SIGN    3.971344 PREVALENT_DEG
## ENSMUSG00000097971 1.040397e-174         SIGN    2.405828 PREVALENT_DEG
## ENSMUSG00000034855 6.620145e-145         SIGN    4.574184 PREVALENT_DEG
## ENSMUSG00000069516 3.027486e-126         SIGN    2.456029 PREVALENT_DEG
##                    mean_expression_cpm
## ENSMUSG00000055493            381.0000
## ENSMUSG00000026822            316.1429
## ENSMUSG00000024164            684.2857
## ENSMUSG00000097971            776.8571
## ENSMUSG00000034855            135.7143
## ENSMUSG00000069516            915.1429

It also contains information on whether the genes are considered to be DE, in the column genes_tag The tag PREVALENT_DEGS refers to those genes that are considered significant in at least n of the DE methods used POSSIBLE_DEGS are those considered significant by at least one method. As such, PREVALENT_DEGS and POSSIBLE_DEGS will be the same when n = 1. N is controlled by the argument minlibraries.

To be considered significant for a given method, a gene must have an adjusted-pvalue < 0.05 and |logFC| > 1; these values are adjustable using the arguments p_val_cutoff and lfc.

The genes_tag columns includes the labels NOT_DEGS and FILTERED_OUT to refer to those genes not detected as DE by at least one DE method and those that do not pass the initial low-count filtering step, controlled by parameters reads and minlibraries.

There is another column, combined_FDR – which is POS/NEG depending on whether the combined adjusted p-value as described above is less than or equal to 0.05 (or whatever the value of the argument p_val_cutoff is).

More complex model designs.

In order to control for specific variables (such as individuals in paired designs, potential confounding factors such as age, etc.),

For example, if we consider our previous experiment, but add an extra column to the target, indicating different age groupings for the samples we obtain the following:

target_multi <- data.frame(target,
  age_group = c("adult", "child", "adult", "child", "adult", "adult", "child"))
target_multi
##    sample treat age_group
## 1   CTL_1  Ctrl     adult
## 2   CTL_2  Ctrl     child
## 3   CTL_3  Ctrl     adult
## 4   CTL_4  Ctrl     child
## 5 epm2a_1 Treat     adult
## 6 epm2a_2 Treat     adult
## 7 epm2a_3 Treat     child

We may wish to control for the effects of age_group on the experiment.

This can be achieved using the argument model_variables. The variables given to this argument will be used in the model when calculating differential expression between the Treat and Ctrl samples:

degh_out_model <- main_degenes_Hunter(raw=toc, target=target_multi, 
                                      modules="D", model_variables="age_group")

This works by using the variable age_group to create a linear model formula to be passed to the different DE methods (with the exception of NOISeq).

The output has the same structure as the original analysis.

Custom model designs can also be specified in the model_variables argument, based on the R model syntax, see help(“formula”) for more details. If a custom formula is used, the custom_model argument must be set to true.

Co-expression Analysis

Co-expression analysis is included via the R package Weighted correlation network analysis (WGCNA). The idea is to look for groups (modules) of genes showing correlated expression. The groups can then be correlated with experimental factors, such as treatment vs. non treatment, as well as other groupings such as the age grouping mentioned earlier, or numeric factors such as known values of metabolites related to the experiment.

WGCNA is activated using by adding “W” to the modules argument. The traits to be correlated with the modules are specified using the string_factors and numeric_factors options:

degh_out_coexp <- main_degenes_Hunter(raw=toc, target=target_multi, 
                                      modules="DW", string_factors="age_group")

Please note that WGCNA requires a normalized expression matrix as input, as such it cannot be run alone, it must be run alongside at least one DE method, which is specified with the argument WGCNA_norm_method.

Functional Analysis - Expression Data

Functional analysis can be performed on the results of the DEG/WGCNA analysis to look for over representation (enrichement) for groups of genes amongst the DEGs and/or modules of genes obtained.

For differentially expressed genes, the following code, which takes as input the output object of running degenes hunter for DE analysis, can be used.

Currently only overrepresentation analysis using the clusterProfiler package is implemented.

fh_out_one_pack <- main_functional_hunter( #Perform enrichment analysis
        degh_out_one_pack,
        model_organism = 'Mouse', # Use specified organism database 
        enrich_dbs = c("MF", "BP", "CC", "Kegg", "Reactome"), # Enrichment analysis for GO, KEGG and Reactome
        enrich_methods = "o" # Use overepresentation analysis only
)

This will produce a list object as output. The members of this list are named: final_main_params - this contains a list with full details of the parameters used

ORA - this list contains the results of the analysis. This is a named list of enrichResult objects, one for each gene annotation database used (e.g. GO BP, Reactome, KEGG, or in the case of a custom gmt annotation file, the file name will be used).

DEGH_results_annot - this is a dataframe containing the results of the DEG/coexpression analysis.

When coexpression analysis has also been run using the main_degenes_Hunter function the following code will

fh_out_coexp <- main_functional_hunter( # Perform enrichment analisys
        degh_out_coexp,
        model_organism = 'Mouse', # Use specified organism database 
        enrich_dbs = c("MF", "BP", "CC", "Kegg", "Reactome"), # Enrichment analysis for GO, KEGG and Reactome
        enrich_methods = "o" # Use overepresentation analysi only
)

Functional Analysis - general

There is also a function to implement functional enrichment more generally, using as input a lists of genes instead of the output of the main_degenes_Hunter function. Each line in the file should contain a list of genes, with the format: identifiergene1,gene2,…

input_file <- system.file("extData", "cluster_genes.txt", package = "ExpHunterSuite")
print(readLines(input_file,n=2))

organisms_table <- get_organism_table()
current_organism_info <- organisms_table[rownames(organisms_table) %in% "Mouse",]
org_db <- get_org_db(current_organism_info)

enr_lists <- main_clusters_to_enrichment(input_file, org_db=org_db, 
    current_organism_info=current_organism_info, gene_keytype="ENSEMBL")

Obtaining Reports

To obtain highly detailed html reports including multiple plots to visualize the data and the results of the different analysis methods, the following commands can be used for main_degenes_Hunter and main_functional_hun:

write_expression_report(exp_results=degh_out_coexp)
write_enrich_files(func_results=fh_out_one_pack)
write_functional_report(hunter_results=degh_out_coexp, 
                        func_results=fh_out_coexp)

In all cases, the output folder for each report can be specified with the output_files option.

Functional Analysis - special options for reports

There are several options when using GO with functional analysis whereby you can exploit the hierarchical nature of this ontology to alter the results.

simplify - simplify the merged enrichments by removing redundant terms, based on semantic similarity, using the simplify() function from clusterProfiler. Uses the Wang method for semantic similarity, with a cutoff of 0.7.

clean_parentals - remove parental GO terms from merged enrichments for each cluster/module. I.e. when the terms in a cluster or module have a parent-child relationship, the child term is kept. Note that different clusters in the merged enrichment might have GOs terms that have a parent-child relationship.

There is also a summary method, which is accessed by adding “S” to the write_clusters_to_enrichment function or by adding a non-null “sim_thr” value to the main_functional_hunter funtion. This function is used to reduce the number of enriched GO terms by clustering similar GO terms and then, for each cluster, choosing either the most signficant term or the most ancestral term, specified using the summary_common_name option.

group_results - The option can be used to group categories with similar names in the emap plots produced in the reports (the graphs that show the connections between terms) and in the plots produced by write_functional_report with mode “P”.

max_genes - the maximum number of genes to plot in the cnet plots - the plots in the reports that shows categories connected to each other via shared genes.

Command-line Package Usage

The package also includes a number of scripts, in the folder inst/scripts, which can be used to run the above functions from the command line.

We recommend the user first creates a folder in which to install the ExpHunterSuite command line scripts, then copies the scripts there and make them command line accesible using these commands:

mkdir install_folder
Rscript -e "ExpHunterSuite::install_DEgenes_hunter('install_folder')"
export PATH=path_to_install_folder:$PATH

This export PATH can also be added to the .bashrc or .bash_profile files.

The user can then run the protocol from the command line with scripts such as the following, which will implement the functions and create the output reports, all from a single script.

degenes_Hunter.R -t $TARGET_FILE -i $TOC -o $EXP_RESULTS
functional_Hunter.R -i $EXP_RESULTS -m Organism -o FUNC_RESULTS

Full details of the arguments to give the the script can be found by running degenes_Hunter.R -h or functional_Hunter.R -h. More examples are given in the README file for this packet

Usage

There are two ways for using DEgenes Hunter: as command line scripts or as an R package. We will explain the procedure to perform both 1. differential expression and 2. functional analysis using the command line.

1. Command line scripts for differential expression analysis.

Once installed, DEgenes Hunter performs the expression analysis from a raw count table. For this, the user must first create a targets file, including for each sample its name in the count table, it treat condition (Treat or Ctrl).This file must contain this information separated by tabs.

Note: we recommend to use ENSEMBL identifiers for the functional analysis.

Here we include an example in which the targets file must include the samples (CTL, TreatA and TreatB), the samples condition (Ctrl or Treat) and to which age_group they belong (adult or child). The correction including additional factors (-v and -M) or co-expression analysis using extra measures (-S and -C) require additional information that must be included in targets file. Extra measures are named as traits. These options use the traits column names as arguments.

sample treat age_group
CTL_1 Ctrl adult
CTL_2 Ctrl child
TreatA_1 Treat adult
TreatA_2 Treat child
TreatB_1 Treat adult
TreatB_2 Treat adult

Once generated, the expression analysis can be performed using degenes_Hunter.R script. For this, we must call degenes_Hunter.R and give it the following input arguments.

Here we show an example of basic usage:

    degenes_Hunter.R -t path_to_target_file -i path_to_counts_table -o path_to_results

Mandatory arguments:

-i | -t 
(mandatory) Specify the path to the input counts/mapping table and to the targets file.

-i Input read counts file.
-t Targets file.

Differential expresion analysis arguments:

-o Output path.
  (optional) Output folder. 
  Default = "./hunter_DE_results"
-r any integer.
  (optional) Number of minimum mapped reads required in order to not be filtered out. Lesser number of reads are discarded. 
  0 = No filtering. 
  By default, reads less than 2 are discarded.
-l any integer <= samples provided in the experiment.
  (optional) Minimum number of libraries that must have reads of a transcript in order to not to be filtered. 
  By default, minimum libraries required are 2.
-p value between 0.01 and 0.1
  (optional) Adjusted p-value for the differential expression analysis. 
  Default = 0.05
-f float
(optional) Minimum log2 fold change in expression. Please, consider this is on a log2 scale, so a value of 1 would mean a 2 fold change.
  Default = 1.
-q value between 0.95 and 0.99
  (optional) q value threshold for NOISeqBIO analysis. 
  Default = 0.95 (recommended)
-a "BH" | "bonferroni" | "holm" | "hochberg" | "hommel" | "BY"
  (optional) adjust method for the combined nominal p-values. 
  By default the BH method is performed.
-n name of your experiment
  (optional) Your experiment name. 
  Default = Experiment1
-m D | E | L | N | W
  (optional) Differential expression packages to analyse data with.
  D = DESeq2, E = edgeR, L = limma, N = NOISeq (NOISeqBIO function within NOISeq package is used), W = WGCNA (this activates the co-expression analysis).
  Default = DELN.
-c 1-4
  (optional) Minimum number of packages to consider a gene as 'Prevalent' DEG.
  Default = 4.
-e External DEG data file.
  (optional) External file with pre-analysed DE data. Must consist of three columns containing p-value, logFC and FDR/p-adjust. Please, respect the columns order.
  Default = NULL.
-v model variables
  (optional) Variables to include in the model. Must be comma separated and each variable must be a column in the target file.
  Default = NULL.
-M model_text
  Text for this variable will be given directly to the model construction, overwriting the previous configuration.

Co-expression analysis arguments:

-b Any integer.
  Maximum block size value to be given to the WGCNA blockwiseModules function as the maxBlockSize argument.
  Default = 5000.
--WGCNA_norm_method NOISeq | DESeq2 | edgeR | limma
  Method used to normalized the table of counts for WGCNA. Must also run this method in the --modules argument. Raw counts are used if an empty string is given.
  Default=DESeq2
--WGCNA_deepsplit 1-4
  This option controls the module building process and is defined as 1,2,3 and 4 values. 1 for rough clustering and 4 for accurate clustering.
  Default = 2.
--WGCNA_min_genes_cluster integer
  Minimum number of genes to keep a cluster.
  Default = 20.
--WGCNA_detectcutHeight 0 - 1 float
  Cut height to split modules.
  Default = 0.995.
--WGCNA_mergecutHeight 0 - 1 float
  Value to merge two similar modules: Maximum dissimilarity (i.e., 1-correlation).
  Default = 0.25.
-w
  Run WGCNA for treated only, control only, and both as 3 separate runs. Needed if using PCIT. If false, WGCNA runs once, on the table including treament and control.
--WGCNA_blockwiseNetworkType unsigned | signed | signed hybrid
  NetworkType option to be passed to blockwiseModules function
  Default = signed.
--WGCNA_blockwiseTOMType none | unsigned | signed | signed Nowick | unsigned 2 | signed 2 | signed Nowick 2
  TOMType option to be passed to blockwiseModules function. 
  Default = signed.
-S comma sepparated text
  Columns in the target file to be used as categorical factors for the correlation analysis. If more than one to be used, should be comma separated
-N comma sepparated text
  Columns in the target file to be used as numeric (continuous) factors for the correlation analysis. If more than one is specified, they must separated by commas.

Results files will be included in the output_path:

* DEG_report.html: file that encompass and summarizes all the information provided by the expression analysis. 
* control_treatment.txt: file that includes information about the samples classification as determined in the targets file.
* filtered_count_data.txt: filtered counts table used the differential expression analysis. Filtering has been performed according to -r, -l and -F options.
* opt_input_values.txt: summary of the parameters used for the differential expression analysis

This folder will also include a Common_results folder with a file (table) with all methods used for the differential expression analysis and their logFC, FDR and p-value calculated, the number of DEGs and values for combined_FDR, FDR_labeling, mean_logFCs and genes_tag, and results for the WGCNA analysis (if established): Cluster_ID and Cluster_MM (MM: module membership).

In addition, the results folder will include subfolders generated in accordance to the methods used for the differential expression analysis (results_DESeq2, Results_edgeR, Results_limma, Results_NOISeq). All these folder include two files, one with the normalized counts for all samples and another one with the results given by each package.

In the case of performing the co-expression analysis with WGCNA, it will be created a Results_WGCNA folder including tables with correlations between modules, genes and traits.

Non-canonical usage scenarios:

A. Differential expression corrected by extra factors

RNA-seq samples can have several additional attributes in addition to the treatment/control status required to detect differential expression. In the previous example, one of these variables is defined in the targets file as age_group. It is possible to include these attribute in the model design as additional factors to control for. In these cases, the differential expression model can be completed by adding the additional argument -v , e.g. -v age_group

An example of code for this analysis is the follows:

    degenes_Hunter.R -t path_to_target_file -i path_to_counts_table -v age_group -o path_to_results
B. Genes co-expression analysis with WGCNA

Co-expression analysis has been included in DEgenes Hunter to detect gene modules with related biological functions. WGCNA can be activated using -m “W” option. Additional traits can be correlated with module mean profile (use -S for discrete columns and -N for continuous column). Here we show an example of using WGCNA with restrictive options:

    degenes_Hunter.R -m WDELN -c 4 -f 1 --WGCNA_mergecutHeight 0.1 --WGCNA_min_genes_cluster 15 --WGCNA_detectcutHeight 0.995 -S age_group -t path_to_targets_file -i path_to_counts_table -o path_to_results
C. Analysing pre-normalized data with WGCNA

DEgenes Hunter requires a table of counts with integers. However, in some situtations, the user may wish to reanalyse a dataset consisting of non-integers, such as microarray data or pre-normalized data.

In this situation, the user can run WGCNA using the data in the table of counts directly, without performing normalization. To do this, they must run degenes_hunter.R with the argument –WGCNA_norm_method equal to “none” and the argument –modules must include “WL”, i.e. specify limma is the only algorithm that will accept normalised values. However the DE results will likely not make much sense.

    degenes_Hunter.R --WGCNA_norm_method none -m WL -c 1 -f 1 -S age_group -t path_to_targets_file -i path_to_normalized_table -o path_to_results
D. Using a pre-calculated list of DEA genes

In some cases, as well as using pre-normalized count data, we wish to use a precalculated list of DE genes. This can be useful if we want to run functional enrichment but not the DE analysis modules.

To do so, the user must provide a preeanalyzed list of DE analysis results. This should consist of four columns, with the following names and corresponding information: Entrez (or other gene id supported by functional hunter), P.Value, logFC and adj.P.Val, in that order.

In such a scenario, the user can provide a target and counts file, in which case the DE output reports will be generated using this information. They can also choose not to provide them, in which case the DE output report will be rather limited.

To run DEgenes Hunter using a pre-calculated gene list, the following command can be used:

    degenes_Hunter.R  -m "F" -t path_to_targets_file -i path_to_normalized_table -e path_to_precalculated_deg_file -o path_to_results
E. Multifactorial (2x2) analysis to look for interactions between factors and effects in distinct groups

Currently only a 2x2 factorial design is possible for interactions, and 2xn for group effects.

In the case of a 2x2 design, if we consider the following experimental design, similar to the one shown above:

sample treat age_group
ad_CTL_1 Ctrl ad
ad_CTL_2 Ctrl ad
ad_CTL_3 Ctrl ad
ch_CTL_1 Ctrl ch
ch_CTL_2 Ctrl ch
ch_CTL_3 Ctrl ch
ad_TRT_1 Treat ad
ad_TRT_2 Treat ad
ad_TRT_3 Treat ad
ch_TRT_1 Treat ch
ch_TRT_2 Treat ch
ch_TRT_3 Treat ch

We can look for an interaction between treatment and age_group, the effects of treatment in a specific age group, or the differences between adults and children among untreated or treated samples.

Interaction can be thought of seeing whether the effect of treatment is different between age groups.

The required contrast (i.e. interaction or effect) must be specified in the following manner, via the flag –multifactorial:

“FactorA,FactorB:contrast”

In the case of an interaction between the factors, the contrast should be specified as “interaction,baseA,baseB”, where baseA and baseB should be the base levels for each factor. The resulting logFC values detected by this contrast would represent \[numA\_numB - baseA\_numB\] - \[numA\_baseB - baseA\_baseB\] with numA/B representing the non-base levels for the factorA.

So, for our example, if one wished to see the interaction between treatment and age_group they should use the following:

degenes_Hunter.R -m "DEL" -i path_to_normalized_table -t path_to_targets_file -o results_2x2_interaction --multifactorial "treat,age_group:interaction,Ctrl,ch"

In the case of the effects of one factor in a group of samples specified by another factor, the contrast should be specified in the form “effect,baseA,groupB”, where the baseA should be the level in FactorA that should be used as the base for FC calculation, and groupB represents the level in Factor B that is the group we are looking for the change in.

So, for our example if one wished to see the effect of treatment in children only, they should use the following:

degenes_Hunter.R -m "DEL" -i path_to_normalized_table -t path_to_targets_file -o results_2x2_effect_treat_ch --multifactorial "treat,age_group:effect,Ctrl,ch"

Similarly, if they wished to see the difference between age groups in the ctrl samples, they should use the following:

degenes_Hunter.R -m "DEL" -i path_to_normalized_table -t path_to_targets_file -o results_2x2_effect_age_ctrl --multifactorial "age_group,treat:effect,ch,Ctrl"

Note FactorB in the effects contrast can have more than 2 groups.

F. Multifactorial nested (2x2xn and 2xnxn) analysis to look for interactions between factors and effects in distinct groups where the groups contain paired samples (e.g. the same patient/control before and after treatment)

NOTE: this can only be used with DESeq2 for now

In some cases we are interested in the differences that occur between case and control samples that occur in one group of samples but not in another, similar to the “interaction” contrast described previously, however we have an added complication: the samples within each group are paired. A typical example would be an experiment in which we have patients and healthy controls, and we want to see how a treatment affects patients, compared to controls. In this case, the control samples are the untreated individuals, and the case samples are the treated individuals. The groups are patients vs. controls. As such we have a 2x2 interaction design. However, if the individuals are paired, i.e. the treated and untreated samples come from the same individual, we can add this to the experiment design so that it can be used in the DEG detection analysis:

sample treat pat_or_hc ind_id
pat_ctrl_1 Ctrl patient p1
pat_ctrl_2 Ctrl patient p2
pat_ctrl_3 Ctrl patient p3
pat_ctrl_4 Ctrl patient p4
pat_treat_1 Treat patient p1
pat_treat_2 Treat patient p2
pat_treat_3 Treat patient p3
pat_treat_4 Treat patient p4
hc_ctrl_1 Ctrl healthy h1
hc_ctrl_2 Ctrl healthy h2
hc_ctrl_3 Ctrl healthy h3
hc_ctrl_4 Ctrl healthy h4
hc_treat_1 Treat healthy h1
hc_treat_2 Treat healthy h2
hc_treat_3 Treat healthy h3
hc_treat_4 Treat healthy h4

As can be observed, the same individual appears twice in the design - corresponding to samples before and after treatment (Ctrl and Treat can of course also refer to e.g. sample from different tissues, etc.,)

This design has the advantage of allowing us to compare the change in gene expression to the starting point of each individual, which may vary.

In this case, we can look for differences between groups (like the interaction shown above for the unpaired design) using the following custom_model:

--multifactorial "pat_or_hc,ind_id:nested_int,Ctrl,patient"

And we can look for changes occurring in the patients group using:

--multifactorial "pat_or_hc,ind_id:nested_effect,Ctrl,patient"

And we can look for changes occurring in the control subjects group using:

--multifactorial "pat_or_hc,ind_id:nested_effect,Ctrl,control"

Note that the changes must always be between Ctrl and Treat samples from the Treatment column, for interactions there must only be two groups, and each sample in each group must appear twice with the same patient ID.

2. Command line scripts for functional enrichment analysis.

To perform the functional enrichment analysis we will use the functional_Hunter.R script. This tool will use the hypergeometric test to enrich genes in functions and pathways from GO, KEGG and Reactome. Depending on the expression analysis performed, the DEgenes Hunter functional analysis tool, functional_Hunter.R, will execute different enrichments:

* When differential expression analysis is launched, all prevalent DEGs will be used to perform the functional enrichment. An html summary will be returned.
* If co-expression analysis is set up, genes from each WGCNA independent module will be used to perform the functional enrichment. An html summary for each module and a global module enrichments summary will be returned.

Here we show an example of basic usage:

    functional_Hunter.R -i path_to_results -m Organism -o path_to_output

Mandatory arguments:

-i | -m | -o 
(required) Specify the path to the degenes_Hunter.R output folder, the model organism to use and the path to the output folder.

-i path
  Path to the ExpHunterSuite differential expression results.
-m organism
  Ortologue species to be used as model organism to perform the functional analysis with. Run 'functional_Hunter.R' -L to display all available organisms.
-o Output path.

Optional input arguments:

-t input_ID
  Input gene IDs of counts table. Available IDs are: ENSEMBL (E), entrezgene (e), TAIR/Arabidopsis (T), Gene Names (G). 
  Default = E.
-L 
  (optional) List all organisms provided.
-a tab_file
  (optional) Path to file with own annotations for functional analysis.
-f G | g | K | R
  Nomenclature and enrichment method(s) to use (topGO: G = GO | clusterProfiler: K = KEGG, g = GO, R = Reactome).
  Default = gKR.
-G M | B | C
 Gene Ontology sub-classification to perform functional enrichment.
  M = Molecular Function (MF), B = Biological Process (BP), C = Celular Components (CC)
  Default = MBC.
-A analysis_type
  Analysis performance (g = Gene Set Enrichment Analysis, o = Over Representation Analysis). 
  Default = go.
-P float
  Enrichment p-value threshold. 
  Default = 0.1.
-Q float
  Enrichment q-value threshold. 
  Default = 0.2.
-c integer
  Cores to be used to parallelize clusters enrichments. 
  Default = 1
-C files
  Files with custom functional annotation database (in GMT format) separated by commas (,)
-r mode
   Flags to activate remote query from enrichments and genes translation. Use (b) to launch biomaRt translation; (k) to use KEGG remote database. Requires internet connection.
   Default = NULL
-q 
(optional) If indicated, biomaRt query is saved in an .RDS file.

DEgenes Hunter functional enrichment examples of use

Here we show an example of use for DEgenes Hunter functional enrichment, changing some input parameters.

Functional enrichment in GO biological processes (-G B) using topGO (-f G) for H. sapiens (-m Human), using a overrepresentation analysis (-A o). P-value threshold set to 0.1 (-P 0.1). ctrl_vs_mut is the input folder with data from the functional expression analysis performed with degenes_Hunter.R (-i). Gene identifiers provided as entrez codes (-t E). Execution parallelized using 6 cores (-c 6).

functional_Hunter.R -f G -G B -A o -P 0.1 -m Human -i ctrl_vs_mut -t E -c 6 -o functional_enrichment