def __doc__(self):
doc = ['Python representation of an R function.']
description = help.docstring(self.__rpackagename__,
self.__rname__,
sections=['description'])
doc.append(description)
fm = _formals_fixed(self)
names = fm.do_slot('names')
doc.append(self.__rname__+'(')
for key, val in self._prm_translate.items():
if key == '___':
description = ('(was "..."). R ellipsis '
'(any number of parameters)')
else:
description = _repr_argval(fm[names.index(val)])
if description is None:
doc.append(' %s,' % key)
else:
doc.append(' %s = %s,' % (key, description))
doc.extend((')', ''))
package = help.Package(self.__rpackagename__)
page = package.fetch(self.__rname__)
for item in page.arguments():
description = item.value
description = description.replace('\n', '')
description, count = pattern_link.subn(r'\1', description)
description, count = pattern_code.subn(r'`\1`', description)
description, count = pattern_samp.subn(r'`\1`', description)
doc.append(' '.join((item.name, ': ', description, ',')))
doc.append('')
return os.linesep.join(doc)
def __doc__(self):
doc = ['Python representation of an R function.']
description = help.docstring(self.__rpackagename__,
self.__rname__,
sections=['description'])
doc.append(description)
fm = _formals_fixed(self)
names = fm.do_slot('names')
doc.append(self.__rname__+'(')
for key, val in self._prm_translate.items():
if key == '___':
description = '(was "..."). R ellipsis (any number of parameters)'
else:
description = _repr_argval(fm[names.index(val)])
if description is None:
doc.append(' %s,' % key)
else:
doc.append(' %s = %s,' % (key, description))
doc.extend((')', ''))
package = help.Package(self.__rpackagename__)
page = package.fetch(self.__rname__)
for item in page.arguments():
description = item.value
description = description.replace('\n', '')
description, count = pattern_link.subn(r'\1', description)
description, count = pattern_code.subn(r'`\1`', description)
description, count = pattern_samp.subn(r'`\1`', description)
doc.append(' '.join((item.name, ': ', description, ',')))
doc.append('')
return os.linesep.join(doc)
def __doc__(self):
doc = ["Python representation of an R function."]
description = docstring(self.__rpackagename__, self.__rname__, sections=["description"])
doc.append(description)
fm = _formals_fixed(self)
names = fm.do_slot("names")
doc.append(self.__rname__ + "(")
for key, val in self._prm_translate.items():
if key == "___":
description = '(was "..."). R ellipsis (any number of parameters)'
else:
description = _repr_argval(fm[names.index(val)])
doc.append(" %s: %s" % (key, description))
doc.extend((")", ""))
arguments = docstring(self.__rpackagename__, self.__rname__, sections=["arguments"])
doc.append(arguments)
doc.append("")
return os.linesep.join(doc)
def __doc__(self):
doc = list(["Python representation of an R package.", "R arguments:", ""])
if not self.__rname__:
doc.append("<No information available>")
else:
try:
doc.append(rhelp.docstring(self.__rname__, self.__rname__ + "-package", sections=["description"]))
except rhelp.HelpNotFoundError as hnf:
doc.append("[R help was not found]")
return os.linesep.join(doc)
def __doc__(self):
doc = list(['Python representation of an R package.'])
if not self.__rname__:
doc.append('<No information available>')
else:
try:
doc.append(rhelp.docstring(self.__rname__,
self.__rname__ + '-package',
sections=['description']))
except rhelp.HelpNotFoundError:
doc.append('[R help was not found]')
return os.linesep.join(doc)
def __doc__(self):
doc = list(['Python representation of an R package.'])
if not self.__rname__:
doc.append('<No information available>')
else:
try:
doc.append(rhelp.docstring(self.__rname__,
self.__rname__ + '-package',
sections=['description']))
except rhelp.HelpNotFoundError as hnf:
doc.append('[R help was not found]')
return os.linesep.join(doc)
def __doc__(self):
doc = [
'Wrapper around an R function.', '',
'The docstring below is built from the R documentation.', ''
]
description = help.docstring(self.__rpackagename__,
self.__rname__,
sections=['\\description'])
doc.append(description)
fm = _formals_fixed(self)
names = fm.do_slot('names')
doc.append(self.__rname__ + '(')
for key, val in self._prm_translate.items():
if key == '___':
description = ('(was "..."). R ellipsis '
'(any number of parameters)')
else:
description = _repr_argval(fm[names.index(val)])
if description is None:
doc.append(' %s,' % key)
else:
doc.append(' %s = %s,' % (key, description))
doc.extend((')', ''))
package = help.Package(self.__rpackagename__)
page = package.fetch(self.__rname__)
doc.append('Args:')
for item in page.arguments():
description = ('%s ' % os.linesep).join(item.value)
doc.append(' '.join((' ', item.name, ': ', description)))
doc.append('')
doc.append(
help.docstring(self.__rpackagename__,
self.__rname__,
sections=['\\details']))
return os.linesep.join(doc)
def __doc__(self):
doc = ['Python representation of an R function.']
description = docstring(self.__rpackagename__,
self.__rname__,
sections=['description'])
doc.append(description)
fm = _formals_fixed(self)
names = fm.do_slot('names')
doc.append(self.__rname__ + '(')
for key, val in self._prm_translate.items():
if key == '___':
description = '(was "..."). R ellipsis (any number of parameters)'
else:
description = _repr_argval(fm[names.index(val)])
doc.append(' %s: %s' % (key, description))
doc.extend((')', ''))
arguments = docstring(self.__rpackagename__,
self.__rname__,
sections=['arguments'])
doc.append(arguments)
doc.append('')
return os.linesep.join(doc)
