Skip to content

Commit

Permalink
initial setup of pkgdown website
Browse files Browse the repository at this point in the history
  • Loading branch information
kollo97 committed Nov 26, 2024
1 parent 6535e42 commit 7bc6277
Show file tree
Hide file tree
Showing 7 changed files with 116 additions and 57 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ R/flippitise.R
^playground
^doc$
^Meta$
^codecov\.yml$
Binary file added ._pkgdown.yml.swp
Binary file not shown.
49 changes: 49 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
release:
types: [published]
workflow_dispatch:

name: pkgdown.yaml

permissions: read-all

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/[email protected]
with:
clean: false
branch: gh-pages
folder: docs
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: anglemania
URL: https://bioinformatics.mdc-berlin.de/anglemania, https://github.com/BIMSBbioinfo/anglemania/
URL: https://bioinformatics.mdc-berlin.de/anglemania, https://github.com/BIMSBbioinfo/anglemania/, http://bioinformatics.mdc-berlin.de/anglemania/
Title: Feature Extraction for scRNA-seq Dataset Integration
Version: 0.99.0
Description: anglemania extracts genes from multi-batch scRNA-seq experiments for downstream dataset integration. It improves conventional usage of highly-variable genes for integration tasks.
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<img src="man/figures/graphical_abstract.png" align="center" alt="logo" width="2000" style = "border: none; float: center ;">

# anglemania
The repository carries the development version of the conceived "anglemania" R package.

## Overview
**anglemania** is a new approach to the integration of scRNA-seq (and, potentially, others sc-omics) from **similar** biological entities.
The novelty, as well as the cornerstone, of the proposed approach, is to use the conservation of [angles](https://arxiv.org/abs/1306.0256) between gene pairs across an assembly of datasets to be integrated.
The novelty, as well as the cornerstone, of the proposed approach, is to use the conservation of [angles](https://arxiv.org/abs/1306.0256) between gene pairs across an assembly of datasets to be integrated.
anglemania extracts genes from gene pairs that exhibit invariant and biologically meaningful relationships across different experiments. Those genes can subsequently be used as the basis for integration algorithms such as [![Seurat CCA integration](https://satijalab.org/seurat/reference/ccaintegration)], [![SCVI](https://docs.scvi-tools.org/en/stable/api/reference/scvi.model.SCVI.html)] and others.
Checkout our [![website](https://bioinformatics.mdc-berlin.de/anglemania)].

| | |
| - | - |
Expand All @@ -15,6 +15,7 @@ The novelty, as well as the cornerstone, of the proposed approach, is to use the




## Installation

You can install **anglemania** from Bioconductor using the following commands:
Expand Down Expand Up @@ -42,7 +43,7 @@ devtools::install_github("BIMSBbioinfo/anglemania/")

## Documentation

Comprehensive documentation is available on our [pkgdown website]
Comprehensive documentation is available on our [![anglemania website](https://bioinformatics.mdc-berlin.de/anglemania)]
Or visit the [Bioconductor package page](https://bioconductor.org/packages/anglemania).

## Getting Help
Expand Down
98 changes: 46 additions & 52 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,57 +1,51 @@
url: "https://bioinformatics.mdc-berlin.de/anglemania"
url: http://bioinformatics.mdc-berlin.de/anglemania/
template:
bootstrap: 5

reference:
- title: Main
desc: >
The two functions for running anglemania.
contents:
- create_anglemania_object
- anglemania

- title: Computation of Statistics
desc: >
Functions that work behind the scenes of anglemania to get the statistics.
contents:
- factorise
- extract_angles

- title: Utilities
desc: >
anglemania utilities.
contents:
- sparse_to_fbm
- get_dstat
- big_mat_list_mean
- get_list_stats
- extract_rows_for_unique_genes
- select_genes
- integrate_by_features
- integrate_seurat_list

- title: Anglem Object Helpers
desc: >
Helper functions to access and set anglem object attributes.
contents:
- anglemania_object-class
- matrix_list
- "matrix_list<-"
- dataset_key
- batch_key
- data_info
- angl_weights
- "angl_weights<-"
- list_stats
- "list_stats<-"
- intersect_genes
- "intersect_genes<-"
- get_anglemania_genes
- add_unique_batch_key

- title: Main
desc: |
The two functions for running anglemania.
contents:
- create_anglemania_object
- anglemania
- title: Computation of Statistics
desc: |
Functions that work behind the scenes of anglemania to get the statistics.
contents:
- factorise
- extract_angles
- title: Utilities
desc: |
anglemania utilities.
contents:
- sparse_to_fbm
- get_dstat
- big_mat_list_mean
- get_list_stats
- extract_rows_for_unique_genes
- select_genes
- integrate_by_features
- integrate_seurat_list
- title: Anglem Object Helpers
desc: |
Helper functions to access and set anglem object attributes.
contents:
- anglemania_object-class
- matrix_list
- matrix_list<-
- dataset_key
- batch_key
- data_info
- angl_weights
- angl_weights<-
- list_stats
- list_stats<-
- intersect_genes
- intersect_genes<-
- get_anglemania_genes
- add_unique_batch_key
articles:
- title: "Articles"
navbar: ~
contents:
- "anglemania_tutorial"
- title: Articles
navbar: ~
contents: anglemania_tutorial

14 changes: 14 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
comment: false

coverage:
status:
project:
default:
target: auto
threshold: 1%
informational: true
patch:
default:
target: auto
threshold: 1%
informational: true

0 comments on commit 7bc6277

Please sign in to comment.