Skip to content

Commit

Permalink
correct documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TomKellyGenetics committed Feb 4, 2020
2 parents dc57ad9 + baa472f commit ffe9f7e
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 11 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Package: leiden
Type: Package
Title: R Implementation of Leiden Clustering Algorithm
Version: 0.3.3
Date: 2020-01-17
Date: 2020-02-03
Authors@R: c(person("S. Thomas", "Kelly", email = "tom.kelly@riken.jp", role = c("aut", "cre", "trl")),
person("Vincent A.", "Traag", email = "v.a.traag@cwts.leidenuniv.nl", role = c("com")))
Description: Implements the 'Python leidenalg' module to be called in R.
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# leiden 0.3.3

* bug fixes for documentation in response to changes to R

see development version: https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16223

# leiden 0.3.2

* added support for passing weighted igraph objects
Expand Down
1 change: 0 additions & 1 deletion R/leiden.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
##' @param resolution_parameter A parameter controlling the coarseness of the clusters
##' @param seed Seed for the random number generator. By default uses a random seed if nothing is specified.
##' @param n_iterations Number of iterations to run the Leiden algorithm. By default, 2 iterations are run. If the number of iterations is negative, the Leiden algorithm is run until an iteration in which there was no improvement.
##' @param ... Arguments to be passed to methods
##' @return A partition of clusters as a vector of integers
##' @examples
##' #check if python is availble
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Leiden Algorithm

## leiden version 0.3.2
## leiden version 0.3.3

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/leiden)](https://cran.r-project.org/package=leiden)
[![Travis Build Status](https://travis-ci.org/TomKellyGenetics/leiden.svg?branch=master)](https://travis-ci.org/TomKellyGenetics/leiden)
Expand Down Expand Up @@ -274,15 +274,15 @@ Please cite this implementation R in if you use it:
To cite the leiden package in publications use:
S. Thomas Kelly (2019). leiden: R implementation of the Leiden algorithm. R
package version 0.3.2 https://github.com/TomKellyGenetics/leiden
package version 0.3.3 https://github.com/TomKellyGenetics/leiden
A BibTeX entry for LaTeX users is
@Manual{,
title = {leiden: R implementation of the Leiden algorithm},
author = {S. Thomas Kelly},
year = {2018},
note = {R package version 0.3.2},
note = {R package version 0.3.3},
url = {https://github.com/TomKellyGenetics/leiden},
}
```
Expand Down
4 changes: 2 additions & 2 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

## Updates

Minor update to include support for weighted igraph objects.
Minor update to include resolve issues with documentation on development version of R.

This release is compatible with proposed changes to the Seurat (v3.1.2) package. This version will be a dependency of Seurat. This version of Seurat is not available for checking with revdep but has been checked locally after installing the develop version from GitHub.
See development version: https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16223

## Python integration

Expand Down
4 changes: 2 additions & 2 deletions inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ citEntry(entry = "Manual",
title = "leiden: R implementation of the Leiden algorithm",
author = personList(as.person("S. Thomas Kelly")),
year = "2019",
note = "R package version 0.3.2",
note = "R package version 0.3.3",
url = "https://github.com/TomKellyGenetics/leiden",

textVersion =
paste("S. Thomas Kelly (2019). leiden: R implementation of the Leiden algorithm. R package version 0.3.2",
paste("S. Thomas Kelly (2019). leiden: R implementation of the Leiden algorithm. R package version 0.3.3",
"https://github.com/TomKellyGenetics/leiden")
)

Expand Down
2 changes: 0 additions & 2 deletions man/leiden.Rd

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

0 comments on commit ffe9f7e

Please sign in to comment.