Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: README.md

Issue 29849585: Issue 6835 - Add R support to python-abp (Closed)
Patch Set: Fixed consistency issues in README.md Created Aug. 31, 2018, 10:17 a.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | abp/filters/rpy.py » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
diff --git a/README.md b/README.md
index e077d07562deeb678d0d43c2d48b67c428691b0d..eef48200688a01fbe4bd93637bf149b557f3785f 100644
--- a/README.md
+++ b/README.md
@@ -159,6 +159,26 @@ All public functions, classes and methods should have docstrings compliant with
[NumPy/SciPy documentation guide][5]. One exception is the constructors of
classes that the user is not expected to instantiate (such as exceptions).
+
+## Using the library with R
+
+Clone the repo to you local machine. Then create a virtualenv and install
+python abp there:
+
+ $ cd python-abp
+ $ virtualenv env
+ $ pip install --upgrade .
+
+Then import it with `reticulate` in R:
+
+ > library(reticulate)
+ > use_virtualenv("~/python-abp/env", required=TRUE)
+ > abp <- import("abp.filters.rpy")
+
+Now you can use the functions with `abp$functionname`, e.g.
+`abp.line2dict("@@||g.doubleclick.net/pagead/$subdocument,domain=hon30.org")`
+
+
[1]: https://adblockplus.org/filters#special-comments
[2]: https://adblockplus.org/filters#options
[3]: http://pytest.org/
« no previous file with comments | « no previous file | abp/filters/rpy.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld