Skip to content

Commit

Permalink
R docs (#226)
Browse files Browse the repository at this point in the history
* In the beginning

* add Rcheck workflow

* fix Rcheck workflow

* fix Rcheck workflow

* styler

* styler

* styler

* rename cellcensus to CellCensus

* rename cellcensus to CellCensus

* pkgdown init

* Add README.md

* Add link to R api in index.rst

* change link

* Delete Rcheck.yml

---------

Co-authored-by: Mike Lin <[email protected]>
  • Loading branch information
ebezzi and mlin authored Mar 3, 2023
1 parent f886ba1 commit 7851047
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 1 deletion.
3 changes: 3 additions & 0 deletions api/r/CellCensus/.Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
^CellCensus\.Rproj$
^\.Rproj\.user$
^LICENSE\.md$
^_pkgdown\.yml$
^docs$
^pkgdown$
^README\.Rmd$
3 changes: 3 additions & 0 deletions api/r/CellCensus/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.Rproj.user
.Rhistory
docs
2 changes: 2 additions & 0 deletions api/r/CellCensus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The `CellCensus` package provides an API to facilitate use of the CZI Science Ce

For more information, see the [cell_census repo](https://github.com/chanzuckerberg/cell-census/).

Also see the [Python API](https://chanzuckerberg.github.io/cell-census/).

## Installation

You can install the development version of CellCensus from [GitHub](https://github.com/) with:
Expand Down
4 changes: 4 additions & 0 deletions api/r/CellCensus/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: ~
template:
bootstrap: 5

3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ Contents
setup
soma
python-api
R API <https://chanzuckerberg.github.io/cell-census/r/index.html>
schema
examples
examples

0 comments on commit 7851047

Please sign in to comment.