Last updated: 2023-06-03

Checks: 7 0

Knit directory: SCREE/

This reproducible R Markdown analysis was created with workflowr (version 1.6.2). The Checks tab describes the reproducibility checks that were applied when the results were created. The Past versions tab lists the development history.


Great! Since the R Markdown file has been committed to the Git repository, you know the exact version of the code that produced these results.

Great job! The global environment was empty. Objects defined in the global environment can affect the analysis in your R Markdown file in unknown ways. For reproduciblity it’s best to always run the code in an empty environment.

The command set.seed(20210907) was run prior to running the code in the R Markdown file. Setting a seed ensures that any results that rely on randomness, e.g. subsampling or permutations, are reproducible.

Great job! Recording the operating system, R version, and package versions is critical for reproducibility.

Nice! There were no cached chunks for this analysis, so you can be confident that you successfully produced the results during this run.

Great job! Using relative paths to the files within your workflowr project makes it easier to run your code on other machines.

Great! You are using Git for version control. Tracking code development and connecting the code version to the results is critical for reproducibility.

The results in this page were generated with repository version dc5b2b2. See the Past versions tab to see a history of the changes made to the R Markdown and HTML files.

Note that you need to be careful to ensure that all relevant files for the analysis have been committed to Git prior to generating the results (you can use wflow_publish or wflow_git_commit). workflowr only checks the R Markdown file, but you know if there are other scripts or data files that it depends on. Below is the status of the Git repository when the results were generated:


Ignored files:
    Ignored:    .Rhistory

Untracked files:
    Untracked:  data/workflow.png
    Untracked:  img/
    Untracked:  output/workflow.png

Note that any generated files, e.g. HTML, png, CSS, etc., are not included in this status report because it is ok for generated content to have uncommitted changes.


These are the previous versions of the repository in which changes were made to the R Markdown (analysis/SCREE.Rmd) and HTML (docs/SCREE.html) files. If you’ve configured a remote Git repository (see ?wflow_git_remote), click on the hyperlinks in the table below to view the files as they were in that past version.

File Version Author Date Message
html 2c16336 HailinWei98 2021-09-23 Build site.
Rmd a2a5b0a HailinWei98 2021-09-23 Publish the initial files for myproject
html eeeebf3 HailinWei98 2021-09-23 Build site.
Rmd 94450d1 HailinWei98 2021-09-23 Publish the initial files for myproject
html 94450d1 HailinWei98 2021-09-23 Publish the initial files for myproject
html 518a5ca HailinWei98 2021-09-22 Build site.
Rmd ab04ccf HailinWei98 2021-09-22 Publish the initial files for myproject
html 855bd74 HailinWei98 2021-09-22 Build site.
Rmd e582e5c HailinWei98 2021-09-22 Publish the initial files for myproject

scRNA-seq

Run with config.csv and reference.csv

If users provide config.csv which include input and reference information and sgRNA reference.csv, SCREE alignment command can be as follows:

SCREE preprocess --datatype RNA --csv config.csv -c 8 -m 50 --output cellranger-RNA --para "--description test"

Run without config.csv and reference.csv

If users don't provide config.csv and sgRNA reference.csv, SCREE alignment command can be as follows, for both mRNA and sgRNA files:

SCREE preprocess --datatype RNA --reference refdata-gex-GRCh38-2020-A --input /folder/of/the/fastq/ --sample /sample/name/of/the/fastq/ -c 8 -m 50 --output cellranger-RNA --para "--description test"

scATAC-seq

For scATAC-seq input, SCREE alignment command can be as follows:

# DNA alignment, generate both bin-based and peak-based matrix

SCREE preprocess --datatype ATAC --reference refdata-cellranger-arc-GRCh38-2020-A-2.0.0 --input /folder/of/the/fastq/ --sample /sample/name/of/the/fastq/ -c 8 -m 50 --output cellranger-ATAC --bin --binsize 5000 --process_n 10000 -l refdata-cellranger-arc-GRCh38-2020-A-2.0.0/star/chrNameLength.txt --para "--description test"

# sgRNA 

SCREE preprocess --datatype RNA --reference sgRNA_reference --input /folder/of/the/fastq/ --sample /sample/name/of/the/fastq/ -c 8 -m 50 --output cellranger-ATAC-sgRNA --para "--description test"

One command analysis

After alignment, users can perform all downstream analyses via the command line and generate a summary HTML file.

SCREE analysis --type RNA --mtx cellranger-RNA/outs/filtered_feature_bc_matrix --sg_format 10X --prefix cellranger-RNA

sessionInfo()
R version 4.0.2 (2020-06-22)
Platform: x86_64-apple-darwin17.0 (64-bit)
Running under: macOS Catalina 10.15.7

Matrix products: default
BLAS:   /Library/Frameworks/R.framework/Versions/4.0/Resources/lib/libRblas.dylib
LAPACK: /Library/Frameworks/R.framework/Versions/4.0/Resources/lib/libRlapack.dylib

locale:
[1] en_US.UTF-8/en_US.UTF-8/en_US.UTF-8/C/en_US.UTF-8/en_US.UTF-8

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base     

other attached packages:
[1] workflowr_1.6.2

loaded via a namespace (and not attached):
 [1] Rcpp_1.0.7        whisker_0.4       knitr_1.33        magrittr_2.0.1   
 [5] R6_2.5.0          rlang_0.4.11      fansi_0.5.0       stringr_1.4.0    
 [9] tools_4.0.2       xfun_0.25         utf8_1.2.2        git2r_0.28.0     
[13] jquerylib_0.1.4   htmltools_0.5.1.1 ellipsis_0.3.2    rprojroot_2.0.2  
[17] yaml_2.2.1        digest_0.6.27     tibble_3.1.3      lifecycle_1.0.0  
[21] crayon_1.4.1      later_1.2.0       sass_0.4.0        vctrs_0.3.8      
[25] promises_1.2.0.1  fs_1.5.0          glue_1.4.2        evaluate_0.14    
[29] rmarkdown_2.10    stringi_1.7.3     bslib_0.2.5.1     compiler_4.0.2   
[33] pillar_1.6.2      jsonlite_1.7.2    httpuv_1.6.1      pkgconfig_2.0.3