readthedocs: Use "Read the Docs" to get help on a Python module/object

In hrbrmstr/sanipy: Bring some sanity to R when working with Python via reticulate

Description

Uses utils::browseURL() to open up a browser window pointing to a https://docs.python.org search for the object in question.

Usage

readthedocs(obj, py_ver = 3, check_keywords = TRUE)

Arguments

obj	the unquoted Python object or a character string with the query keyword
check_keywords	logical; if TRUE check_keywords=yes will be used in the docs.python.org URL
pyver	defautls to 3 but you can use any Python version string

Details

You pass in the object itself (the function will handle the rest) or a character string with the item to lookup.

Examples

## Not run: 
library(reticulate)

mailbox = import("mailbox")
readthedocs(mailbox)

# or

readthedocs("mailbox")

## End(Not run)

hrbrmstr/sanipy documentation built on May 20, 2019, 11:58 a.m.