Skip to content

Commit

Permalink
update website to reflect 0.9.1 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim committed Oct 24, 2023
1 parent 78b91cb commit f70e096
Show file tree
Hide file tree
Showing 49 changed files with 244 additions and 573 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: sceptre
Title: Analysis of Single-Cell CRISPR Screen Data
Version: 0.9.0
Version: 0.9.1
Authors@R:
c(person(given = "Timothy",
family = "Barry",
Expand Down
516 changes: 0 additions & 516 deletions NEWS.html

This file was deleted.

8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# sceptre 0.9.1 (2023-10-24)

Version 0.9.1 is a minor update to version 0.9.0.

- We have added an experimental `import_data_from_parse()` function to import data from the output of Parse Biosciences CRISPR Detect.

- We have added support for the `"bonferroni"` gRNA integration strategy.

# sceptre 0.9.0 (2023-10-20)

Version 0.9.0 is a total rework of the `sceptre` package. The new version of the package has a fresh user interface and is faster, more memory-efficient, and more fully featured than previous versions. We summarize key updates here.
Expand Down
2 changes: 1 addition & 1 deletion R/import_functs.R
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ write_sceptre_object_to_cellranger_format <- function(sceptre_object, directory)

#' Import data from Parse (experimental)
#'
#' `import_data_from_parse()` imports data from the output of the Parse count matrix generation program. See \href{https://timothy-barry.github.io/sceptre-book/sceptre.html#sec-whole_game_import_data}{Section 1 of the introductory chapter in the manual} for more information about this function. It is assumed that the data are stored in a single set of files (as opposed to multiple sets of files corresponding to, e.g., different samples).
#' `import_data_from_parse()` imports data from the output of the Parse count matrix generation program. See \href{https://timothy-barry.github.io/sceptre-book/import-data.html#import-from-the-parse-program-experimental}{Chapter 1 of the manual} for more information about this function. It is assumed that the data are stored in a single set of files (as opposed to multiple sets of files corresponding to, e.g., different samples).
#'
#' `import_data_from_parse()` is experimental, and the API of this function is subject to change. We expect the API to solidify as we learn more about the Parse platform and the structure of the Parse count matrix generation program output.
#'
Expand Down
3 changes: 2 additions & 1 deletion R/sceptre.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ utils::globalVariables(c("n_nonzero_trt", "n_nonzero_cntrl", "pair_str", "assign
"multiple_grnas", "x", "grna_id", "grna_expressions_bin", "bin_counts",
"significant", "lab", "p_values", "pass_qc", "fraction_cells_removed",
"grna_id", "pass_qc", "grna_group", "p_value", "gene_id", "response_id",
"log_2_fold_change", "reject", "y", "grna_target", "gene_position_data_frame_grch38"))
"log_2_fold_change", "reject", "y", "grna_target", "gene_position_data_frame_grch38",
"any_pass_qc"))
#' sceptre
#'
#' `sceptre` is an R package for single-cell CRISPR screen data analysis that emphasizes statistical rigor, computational efficiency, and ease of use.
Expand Down
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,19 @@ An R package for single-cell CRISPR screen data analysis, emphasizing statistica

<!-- badges: end -->

## Release of `sceptre` v0.9.0
## Release of `sceptre` v0.9.1

We are excited to announce the release of `sceptre` v0.9.0, a substantial update to the package. This milestone includes the following developments:
We are excited to announce the release of `sceptre` v0.9.1, a substantial update to the package. This milestone includes the following developments:

- A reimagined user experience based on a modular, object-oriented workflow.
- Further improvements in speed and memory efficiency.
- A unified interface for low- and high-MOI analyses.
- A suite of plotting functions facilitating visualization of each step in the pipeline.
- Expanded support for gRNA assignment and quality control.
- Interoperability with output from 10X Cell Ranger (available now) and Parse Biosciences (coming soon).
- Interoperability with output from 10X Cell Ranger and Parse Biosciences CRISPR Detect.
- An [e-book](https://timothy-barry.github.io/sceptre-book/) guiding users through the entire process of analyzing their data using `sceptre`.

`sceptre` v0.9.0 facilitates an entire analysis pipeline for single-cell CRISPR screens, starting from UMI count data obtained from tools like 10X Cell Ranger.
`sceptre` v0.9.1 facilitates an entire analysis pipeline for single-cell CRISPR screens, starting from UMI count data obtained from tools like 10X Cell Ranger.

```{=html}
<!--
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ statistical rigor, computational efficiency, and ease of use.

<!-- badges: end -->

## Release of `sceptre` v0.9.0
## Release of `sceptre` v0.9.1

We are excited to announce the release of `sceptre` v0.9.0, a
We are excited to announce the release of `sceptre` v0.9.1, a
substantial update to the package. This milestone includes the following
developments:

Expand All @@ -31,13 +31,13 @@ developments:
- A suite of plotting functions facilitating visualization of each step
in the pipeline.
- Expanded support for gRNA assignment and quality control.
- Interoperability with output from 10X Cell Ranger (available now) and
Parse Biosciences (coming soon).
- Interoperability with output from 10X Cell Ranger and Parse
Biosciences CRISPR Detect.
- An [e-book](https://timothy-barry.github.io/sceptre-book/) guiding
users through the entire process of analyzing their data using
`sceptre`.

`sceptre` v0.9.0 facilitates an entire analysis pipeline for single-cell
`sceptre` v0.9.1 facilitates an entire analysis pipeline for single-cell
CRISPR screens, starting from UMI count data obtained from tools like
10X Cell Ranger.

Expand Down
1 change: 1 addition & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ reference:
contents:
- import_data
- import_data_from_cellranger
- import_data_from_parse
- set_analysis_parameters
- assign_grnas
- run_qc
Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/LICENSE.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/install.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/articles/sceptre.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion docs/news/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pkgdown_sha: ~
articles:
install: install.html
sceptre: sceptre.html
last_built: 2023-10-23T16:53Z
last_built: 2023-10-24T18:19Z
urls:
reference: https://katsevich-lab.github.io/sceptre/reference
article: https://katsevich-lab.github.io/sceptre/articles
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/assign_grnas.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/construct_cis_pairs.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/construct_positive_control_pairs.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/construct_trans_pairs.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/gene_position_data_frame_grch38.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/get_result.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/grna_target_data_frame_highmoi.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/highmoi_example_data.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/import_data.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit f70e096

Please sign in to comment.