Skip to content

Commit b9f3547

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent ad6d5af commit b9f3547

7 files changed

Lines changed: 50 additions & 50 deletions

File tree

docs/CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
88

99
Examples of behavior that contributes to creating a positive environment include:
1010

11-
- Using welcoming and inclusive language
12-
- Being respectful of differing viewpoints and experiences
13-
- Gracefully accepting constructive criticism
14-
- Focusing on what is best for the community
15-
- Showing empathy towards other community members
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
1616

1717
Examples of unacceptable behavior by participants include:
1818

19-
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20-
- Trolling, insulting/derogatory comments, and personal or political attacks
21-
- Public or private harassment
22-
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23-
- Other conduct which could reasonably be considered inappropriate in a professional setting
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2424

2525
## Our Responsibilities
2626

docs/CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Report bugs using GitHub issues.
99

1010
If you are reporting a bug, please include:
1111

12-
- Your operating system name and version.
13-
- Any details about your local setup that might be helpful in troubleshooting.
14-
- Detailed steps to reproduce the bug.
12+
- Your operating system name and version.
13+
- Any details about your local setup that might be helpful in troubleshooting.
14+
- Detailed steps to reproduce the bug.
1515

1616
## Fix Bugs
1717

@@ -35,10 +35,10 @@ The best way to send feedback is to file an issue on GitHub.
3535

3636
If you are proposing a feature:
3737

38-
- Explain in detail how it would work.
39-
- Keep the scope as narrow as possible, to make it easier to implement.
40-
- Remember that this is a volunteer-driven project, and that contributions
41-
are welcome :)
38+
- Explain in detail how it would work.
39+
- Keep the scope as narrow as possible, to make it easier to implement.
40+
- Remember that this is a volunteer-driven project, and that contributions
41+
are welcome :)
4242

4343
## Get Started
4444

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ ALLCools documentation
88

99
If you'd like to develop on and build the ALLCools book, you should:
1010

11-
- Clone this repository and run
12-
- Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
13-
- (Recommended) Remove the existing `ALLCools/_build/` directory
14-
- Run `jupyter-book build ALLCools/`
11+
- Clone this repository and run
12+
- Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
13+
- (Recommended) Remove the existing `ALLCools/_build/` directory
14+
- Run `jupyter-book build ALLCools/`
1515

1616
A fully-rendered HTML version of the book will be built in `ALLCools/_build/html/`.
1717

@@ -21,8 +21,8 @@ The html version of the book is hosted on the `gh-pages` branch of this repo. A
2121

2222
If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:
2323

24-
- Navigating to your local build; and running,
25-
- `ghp-import -n -p -f ALLCools/_build/html`
24+
- Navigating to your local build; and running,
25+
- `ghp-import -n -p -f ALLCools/_build/html`
2626

2727
This will automatically push your build to the `gh-pages` branch. More information on this hosting process can be found [here](https://jupyterbook.org/publish/gh-pages.html#manually-host-your-book-with-github-pages).
2828

docs/allcools/cell_level/basic/intro_basic_clustering.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ The dataset we used for 100Kb clustering documentation comes from the hippocampu
1414

1515
#### Download Input Files
1616

17-
- Cell metadata: ADD DOWNLOAD URL
18-
- single-cell ALLC files: ADD DOWNLOAD URL
19-
- MCDS files: ADD DOWNLOAD URL
17+
- Cell metadata: ADD DOWNLOAD URL
18+
- single-cell ALLC files: ADD DOWNLOAD URL
19+
- MCDS files: ADD DOWNLOAD URL
2020

2121
### For 5Kb bins clustering
2222

2323
The dataset we used for 5Kb clustering documentation comes from human PBMC (ADD REFERENCE).
2424

2525
#### Download Input Files
2626

27-
- Cell metadata: ADD DOWNLOAD URL
28-
- single-cell ALLC files: ADD DOWNLOAD URL
29-
- MCDS files: ADD DOWNLOAD URL
27+
- Cell metadata: ADD DOWNLOAD URL
28+
- single-cell ALLC files: ADD DOWNLOAD URL
29+
- MCDS files: ADD DOWNLOAD URL
3030

3131
## Prepare your own datasets
3232

docs/allcools/intro.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ ALLCools documentation organization.
2121

2222
## Authors
2323

24-
- Hanqing Liu, developer, initial conception
25-
- Jingtian Zhou, developer, 5kb clustering algorithms
26-
- Wei Tian
27-
- Jiaying Xu
24+
- Hanqing Liu, developer, initial conception
25+
- Jingtian Zhou, developer, 5kb clustering algorithms
26+
- Wei Tian
27+
- Jiaying Xu
2828

2929
## Support
3030

@@ -37,10 +37,10 @@ figclass: margin
3737
Click on this to create a page specific issue.
3838
```
3939

40-
- The source code is on [github](https://github.com/lhqing/ALLCools);
41-
- For releases and changelog, please check out the [github releases page](https://github.com/lhqing/ALLCools/releases);
42-
- For bugs and feature requests, please use the [issue tracker](https://github.com/lhqing/ALLCools/issues).
43-
- For page-specific issues, please use the "open issue" button on the top-right toggle.
40+
- The source code is on [github](https://github.com/lhqing/ALLCools);
41+
- For releases and changelog, please check out the [github releases page](https://github.com/lhqing/ALLCools/releases);
42+
- For bugs and feature requests, please use the [issue tracker](https://github.com/lhqing/ALLCools/issues).
43+
- For page-specific issues, please use the "open issue" button on the top-right toggle.
4444

4545
## Citing ALLCools
4646

docs/allcools/start/analysis_steps.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ In general, the **cellular analysis** is focused on individual cells' overall di
2020

2121
### Sections
2222

23-
- [Basic walk-through of the clustering analysis](../cell_level/basic/intro_basic_clustering.md).
24-
- [Step-by-step description of the clustering analysis](../cell_level/step_by_step/intro_step_by_step_clustering.md).
25-
- [Identification of Differentially Methylated Genes clusters](../cell_level/dmg/intro_dmg.md).
26-
- [Cell-level data integration](../cell_level/integration/intro_integration.md).
27-
- [Potential cell doublets identification](../cell_level/doublets/intro_doublets.md).
23+
- [Basic walk-through of the clustering analysis](../cell_level/basic/intro_basic_clustering.md).
24+
- [Step-by-step description of the clustering analysis](../cell_level/step_by_step/intro_step_by_step_clustering.md).
25+
- [Identification of Differentially Methylated Genes clusters](../cell_level/dmg/intro_dmg.md).
26+
- [Cell-level data integration](../cell_level/integration/intro_integration.md).
27+
- [Potential cell doublets identification](../cell_level/doublets/intro_doublets.md).
2828

2929
### Input
3030

@@ -49,12 +49,12 @@ Specifically, this strategy starts from a cell-by-5kb-bin hypo-methylation score
4949

5050
### Sections
5151

52-
- [Prepare pseudo-bulk ALLC files](../cluster_level/intro.md)
53-
- [Call Differentially Methylated Region (DMR)](../cluster_level/RegionDS/01a.call_dmr)
54-
- [DMR annotation](../cluster_level/RegionDS/02.annotation.ipynb)
55-
- [DMR motif analysis (finding upstream regulators of DMRs)](../cluster_level/RegionDS/intro_motif.md)
56-
- [DMR - Gene correlation analysis (finding downstream targets of DMRs)](../cluster_level/Correlation/intro_corr)
57-
- [Enhancer prediction with REPTILE algorithm](../cluster_level/REPTILE/intro_reptile.md)
52+
- [Prepare pseudo-bulk ALLC files](../cluster_level/intro.md)
53+
- [Call Differentially Methylated Region (DMR)](../cluster_level/RegionDS/01a.call_dmr)
54+
- [DMR annotation](../cluster_level/RegionDS/02.annotation.ipynb)
55+
- [DMR motif analysis (finding upstream regulators of DMRs)](../cluster_level/RegionDS/intro_motif.md)
56+
- [DMR - Gene correlation analysis (finding downstream targets of DMRs)](../cluster_level/Correlation/intro_corr)
57+
- [Enhancer prediction with REPTILE algorithm](../cluster_level/REPTILE/intro_reptile.md)
5858

5959
### Basic process of genomic analysis
6060

docs/allcools/start/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ conda deactivate
123123

124124
Here are some optional packages which might be hard to install on some old systems.
125125

126-
- `rpy2` (R and the R package pvclust) is used for the cluster dendrogram.
127-
- `tpot` is used in REPTILE model.
126+
- `rpy2` (R and the R package pvclust) is used for the cluster dendrogram.
127+
- `tpot` is used in REPTILE model.
128128

129129
```shell
130130
mamba install -n allcools rpy2

0 commit comments

Comments
 (0)