Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
anngvu committed Jul 15, 2024
1 parent f2473f1 commit a14c6d6
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,20 @@ You can install `nfportalutils` from here:
remotes::install_github("nf-osi/nfportalutils")
```

The package interops with the [Python synapse client](https://github.com/Sage-Bionetworks/synapsePythonClient) via reticulate.
You will have to download the Python synapse client first.


## Additional Notes for Users
## For Users

- View function reference on docs site at [Reference](https://nf-osi.github.io/nfportalutils/reference/index.html).
- An alternative to viewing vignettes as Articles on the [docs site](https://nf-osi.github.io/nfportalutils/index.html) is to download them with pkg install and load with e.g. `vignette("annotate-nf-processed-data", package = "nfportalutils")` to view.

## Additional Notes for Contributors
## For Contributors

### General picture
- Again, default development happens in `develop`.
- But we have a side branch called `develop-synapser` where interop tries to transition to `synapser`.
However, current coexistence makes development a bit tricky so consult first before trying new developments there.

### Contrib workflow
- Branch of `develop` and make changes
Expand Down

0 comments on commit a14c6d6

Please sign in to comment.