package installation and documenation

[grst]

the simulator should be a self-contained R package in the end that

• can be installed and
• has enough documentation for a novice user to simulate some data

[grst]

Hi @alex-d13,

in addition to the vignette, do you also have an API documentation (similar to this for the omnideconv package)?

In general, I would recommend to take a look at the pkgdown package, it provides an easy way to generate a documentation website on github pages that contains both function reference and vignette.

[alex-d13]

Hi,

the API documentation+vignette can be found here now: https://alex-d13.github.io/

[grst]

sweet :)

as a next step you could consider setting up a GitHub action that builds & uploads the docs on every commit. You can take a look at Konstantin's omnideconv repo for an example.

[grst]

and btw,

this

conda create --name sfaira python=3.9
conda activate sfaira
conda install pip
git clone https://github.com/theislab/sfaira.git
cd sfaira
git checkout dev
git pull
/path/to/conda/envs/sfaira/bin/pip install -e . #this ensures that the correct pip is used

can be simplified into

conda create --name sfaira python=3.9 pip
conda activate sfaira
pip install git+https://github.com/theislab/sfaira.git@dev