Skip to content

Commit 817ea64

Browse files
remove unnecessary skips
1 parent 6983971 commit 817ea64

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,21 @@ below:
5656
documentation helpful.
5757
![](<https://i.imgur.com/fUcpLYl.png>" width=400px>
5858
4. Set up [tower.nf](https://tower.nf) and make sure you have access to
59-
[`openproblems-bio`](https://tower.nf/orgs/openproblems-bio/workspaces/openproblems-bio/watch). <!-- markdownlint-disable-line MD013 -->
59+
[`openproblems-bio`](https://tower.nf/orgs/openproblems-bio/workspaces/openproblems-bio/watch).
6060
If you do not have access, please contact us at
61-
[singlecellopenproblems@protonmail.com](mailto:singlecellopenproblems@protonmail.com). <!-- markdownlint-disable-line MD013 -->
61+
[singlecellopenproblems@protonmail.com](mailto:singlecellopenproblems@protonmail.com).
6262
5. Create repository secrets (*not environment secrets*)
63-
[https://github.com/USERNAME/openproblems/settings/secrets](https://github.com/USERNAME/openproblems/settings/secrets) <!-- markdownlint-disable-line MD013 -->
63+
[https://github.com/USERNAME/openproblems/settings/secrets](https://github.com/USERNAME/openproblems/settings/secrets)
6464
* *AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are included in your AWS login
6565
details. If you do not have these, please contact us at
66-
[singlecellopenproblems@protonmail.com](mailto:singlecellopenproblems@protonmail.com).* <!-- markdownlint-disable-line MD013 -->
66+
[singlecellopenproblems@protonmail.com](mailto:singlecellopenproblems@protonmail.com).*
6767
* *TOWER_ACCESS_KEY: log in with GitHub to <https://tower.nf> and create a token at
6868
<https://tower.nf/tokens>.*
6969
* When you are done with this step, your page should look like this:
7070
![AWS secrets success](static/img/AWS_secret.png)
7171

7272
6. Enable workflows at
73-
[https://github.com/USERNAME/openproblems/actions](https://github.com/USERNAME/openproblems/actions). <!-- markdownlint-disable-line MD013 -->
73+
[https://github.com/USERNAME/openproblems/actions](https://github.com/USERNAME/openproblems/actions).
7474
7. Set up your git repository to fetch branches from `base` at
7575
`openproblems-bio/openproblems`
7676

@@ -93,7 +93,7 @@ below:
9393
```
9494
9595
To generate an SSH key and add it to your GitHub account, follow [this tutorial from
96-
GitHub](https://docs.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account). <!-- markdownlint-disable-line MD013 -->
96+
GitHub](https://docs.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account).
9797
9898
8. Create a new branch for your task (**no underscores or spaces allowed**). It is best
9999
to coordinate with other people working on the same feature as you so that there
@@ -118,7 +118,7 @@ below:
118118
9. Sometimes, changes might be made to the openproblems `base` repository that you want
119119
to incorporate into your fork. To sync your fork from `base`, use the following code
120120
adapted from the [Syncing a
121-
Fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) <!-- markdownlint-disable-line MD013 -->
121+
Fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)
122122
tutorial from GitHub.
123123
124124
```shell
@@ -169,7 +169,7 @@ If your method takes hyperparameters, set them as keyword arguments in the metho
169169
definition. If the hyperparameters change depending on the value of `test`, set the
170170
keyword argument to `None` and set them to your chosen defaults only if the passed value
171171
is `None`. For an example, see [harmonic
172-
alignment](openproblems/tasks/multimodal_data_integration/methods/harmonic_alignment.py). <!-- markdownlint-disable-line MD013 -->
172+
alignment](openproblems/tasks/multimodal_data_integration/methods/harmonic_alignment.py).
173173

174174
Metrics should take an AnnData object and return a `float`.
175175

@@ -268,7 +268,7 @@ function](./openproblems/tools/normalize.py) (e.g.,
268268
`adata.layers["log_scran_pooling"]`).
269269

270270
To see a gold standard loader, look at
271-
[openproblems/data/Wagner_2018_zebrafish_embryo_CRISPR.py](./openproblems/data/Wagner_2018_zebrafish_embryo_CRISPR.py) <!-- markdownlint-disable-line MD013 -->
271+
[openproblems/data/Wagner_2018_zebrafish_embryo_CRISPR.py](./openproblems/data/Wagner_2018_zebrafish_embryo_CRISPR.py)
272272

273273
This file name should match
274274
`[First Author Last Name]_[Year Published]_short_Description_of_data.py`. E.g. the
@@ -287,7 +287,7 @@ from .f2 import f2
287287
```
288288

289289
to
290-
[`openproblems/tasks/label_projection/metrics/__init__.py`](openproblems/tasks/label_projection/metrics/__init__.py). <!-- markdownlint-disable-line MD013 -->
290+
[`openproblems/tasks/label_projection/metrics/__init__.py`](openproblems/tasks/label_projection/metrics/__init__.py).
291291

292292
For datasets in particular, these should be loaded using a `loader` function from
293293
`openproblems.data`, with only task-specific annotations added in the task-specific data

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Formalizing and benchmarking open problems in single-cell genomics.
1717
* For contributing guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md)
1818
* For instructions on editing Docker images, see [docker/README.md](docker/README.md)
1919
* For instructions on using the `openproblems-cli`, see
20-
[openproblems/api/README.md](https://github.com/singlecellopenproblems/SingleCellOpenProblems/tree/master/openproblems/api) <!-- markdownlint-disable-line MD013 -->
20+
[openproblems/api/README.md](https://github.com/singlecellopenproblems/SingleCellOpenProblems/tree/master/openproblems/api)
2121
* For a walkthrough of the GitHub Actions workflows and AWS Sagemaker, see
2222
[SAGEMAKER.md](SAGEMAKER.md)
2323
* For a description of existing an proposed tasks, see [TASKS.md](TASKS.md)

TASKS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ consistency between the gene scores and gene expression across cells.
3636

3737
Two representative software
3838
[ArchR](https://www.archrproject.com/bookdown/calculating-gene-scores-in-archr.html) and
39-
[MAESTRO](https://github.com/liulab-dfci/MAESTRO/blob/d58fc186a4329febde3b0d5b213c2d0edf8de44c/example/Gene_activity_modelling/Gene_activity_modelling.md), <!-- markdownlint-disable-line MD013 -->
39+
[MAESTRO](https://github.com/liulab-dfci/MAESTRO/blob/d58fc186a4329febde3b0d5b213c2d0edf8de44c/example/Gene_activity_modelling/Gene_activity_modelling.md),
4040
each has different way of assigning peak weights upon genes include a set of methods,
4141
but also share some common property. A typical algorithm includes the following common
4242
steps:
@@ -112,7 +112,7 @@ experiments have been growing in terms of the number of cells measured. Original
112112
cutting-edge SmartSeq experiments would yield a few hundred cells, at best. Now, it is
113113
not uncommon to see experiments that yield over [100,000
114114
cells](https://www.nature.com/articles/s41586-018-0590-4) or even [>1 million
115-
cells.](https://www.10xgenomics.com/blog/our-13-million-single-cell-dataset-is-ready-to-download) <!-- markdownlint-disable-line MD013 -->
115+
cells.](https://www.10xgenomics.com/blog/our-13-million-single-cell-dataset-is-ready-to-download)
116116

117117
Each *feature* in a dataset functions as a single dimension. While each of the ~30,000
118118
dimensions measured in each cell (not accounting for roughly 75-90% data dropout per

docker/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,15 +142,15 @@ cd workflow && snakemake -j 10 docker_build
142142
Docker images are built by the `run_benchmarks` GitHub Actions workflow on both the base
143143
repository and on forks. As long as you have AWS secrets configured properly for your
144144
repository (see our [Contributing
145-
Guide](https://github.com/openproblems-bio/openproblems/blob/main/CONTRIBUTING.md#submitting-new-features)), <!-- markdownlint-disable-line MD013 -->
145+
Guide](https://github.com/openproblems-bio/openproblems/blob/main/CONTRIBUTING.md#submitting-new-features)),
146146
these images will be uploaded to Amazon Web Services [Elastic Container
147147
Registry](https://aws.amazon.com/ecr/) (ECR). You can then download the image locally or
148148
attach to AWS SageMaker Studio.
149149

150150
Once your Run Benchmark has completed successfully, you should see a pane in the GitHub
151151
Actions tab of your fork that looks like this:
152152

153-
![Successful Actions run](https://user-images.githubusercontent.com/8322751/112719533-c508e100-8ecf-11eb-91b0-6f99ccee2e3f.png) <!-- markdownlint-disable-line MD013 -->
153+
![Successful Actions run](https://user-images.githubusercontent.com/8322751/112719533-c508e100-8ecf-11eb-91b0-6f99ccee2e3f.png)
154154

155155
If that workflow failed, you should look at the workflow logs to find the error.
156156

@@ -165,12 +165,12 @@ As you can see below, images uploaded to the ECR have Image Tags in the followin
165165
`openproblems-python37-scgen` image. This is converted to an Image Tag
166166
`daniel-batch-integration-openproblems-python37-scgen`.
167167

168-
![ECR example screen](https://user-images.githubusercontent.com/8322751/112719414-43b14e80-8ecf-11eb-8fe2-5588e42c77c5.png) <!-- markdownlint-disable-line MD013 -->
168+
![ECR example screen](https://user-images.githubusercontent.com/8322751/112719414-43b14e80-8ecf-11eb-8fe2-5588e42c77c5.png)
169169

170170
## Pulling images from the ECR to your local machine
171171

172172
To pull images from the ECR using `docker pull`, first download and setup the
173-
[`amazon-ecr-credential-helper`](https://github.com/awslabs/amazon-ecr-credential-helper) <!-- markdownlint-disable-line MD013 -->
173+
[`amazon-ecr-credential-helper`](https://github.com/awslabs/amazon-ecr-credential-helper)
174174
using the same AWS secrets that you used to set up your fork repository. With that set
175175
up you can use the following command to pull the image:
176176

openproblems/tasks/dimensionality_reduction/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ scRNA-seq experiments have been growing in terms of the number of cells measured
1010
Originally, cutting-edge SmartSeq experiments would yield a few hundred cells, at best.
1111
Now, it is not uncommon to see experiments that yield over [100,000 cells]
1212
(<https://www.nature.com/articles/s41586-018-0590-4>) or even [> 1 million
13-
cells.](https://www.10xgenomics.com/blog/our-13-million-single-cell-dataset-is-ready-to-download) <!-- markdownlint-disable-line MD013 -->
13+
cells.](https://www.10xgenomics.com/blog/our-13-million-single-cell-dataset-is-ready-to-download)
1414

1515
Each *feature* in a dataset functions as a single dimension. While each of the ~30,000
1616
dimensions measured in each cell (not accounting for roughly 75-90% data dropout per
@@ -29,7 +29,7 @@ the data for visualization and interpretation.
2929
[Reference](https://www.tandfonline.com/doi/abs/10.1080/14786440109462720)
3030

3131
*Adapted from the [sklearn
32-
documentation](https://scikit-learn.org/stable/modules/generated/sklearn.decomposition.PCA.html)*. <!-- markdownlint-disable-line MD013 -->
32+
documentation](https://scikit-learn.org/stable/modules/generated/sklearn.decomposition.PCA.html)*.
3333

3434
Linear dimensionality reduction using Singular Value Decomposition of the data to
3535
project it to a lower dimensional space. The input data is centered but not scaled for
@@ -43,7 +43,7 @@ by [scanpy](https://scanpy.readthedocs.io/en/stable/generated/scanpy.tl.pca.html
4343
[Reference](https://arxiv.org/abs/1802.03426)
4444

4545
*Adapted from the [sklearn
46-
documentation](https://scikit-learn.org/stable/modules/generated/sklearn.manifold.TSNE.html)*. <!-- markdownlint-disable-line MD013 -->
46+
documentation](https://scikit-learn.org/stable/modules/generated/sklearn.manifold.TSNE.html)*.
4747

4848
t-SNE is a tool to visualize high-dimensional data. It converts similarities between
4949
data points to joint probabilities and tries to minimize the Kullback-Leibler divergence
@@ -159,7 +159,7 @@ of the ***topography*** of the data in high-dimensional space.
159159
### Trustworthiness
160160

161161
*Adapted from the [sklearn
162-
documentation.](https://scikit-learn.org/stable/modules/generated/sklearn.manifold.trustworthiness.html)* <!-- markdownlint-disable-line MD013 -->
162+
documentation.](https://scikit-learn.org/stable/modules/generated/sklearn.manifold.trustworthiness.html)*
163163

164164
Trustworthiness expresses to what extent the local structure in an embedding is
165165
retained. The trustworthiness is within [0, 1]. It is defined as

openproblems/tasks/label_projection/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ assigns cell type labels to cells in the test set.
3131

3232
* **Accuracy**: Average number of correctly applied labels.
3333
* **F1 score**: The [F1
34-
score](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.f1_score.html) <!-- markdownlint-disable-line MD013 -->
34+
score](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.f1_score.html)
3535
is a weighted average of the precision and recall over all class labels, where an F1
3636
score reaches its best value at 1 and worst score at 0, where each class contributes
3737
to the score relative to its frequency in the dataset.

0 commit comments

Comments
 (0)