API Docs / REnv

REnv 5.1.3.5558.

01 Namespaces

SMRUCC.Rsharp

Type	Summary	Members
ApiArgumentHelpers		8
Extensions		14
LICENSE	Information about the R# interpreter code module.	3

SMRUCC.Rsharp.Development

Type	Summary	Members
AnnotationDocs	Parser of the Project assembly	4
ConsoleMarkdownPrinter		5
ConsoleSyntaxHighlightPrinter	Print R# code with syntax highlight on the console by use ascii escape sequence	3
Document	R comment documentation model	13
FunctionDeclare		7
RFileSystem		3
RuntimeError		2
UnixManPagePrinter		2

SMRUCC.Rsharp.Development.CodeAnalysis

Type	Summary	Members
FunctionTree		5
RlangTranslator	helper module for translate the R# code to R language	2
SymbolAnalysis	analysis of the static symbol reference	5
SymbolTypeDefine	the general definition model of the symbol or function in typescript	8
TypeScriptDefine	the generator module for the type script definition	6
TypeWriter		4

SMRUCC.Rsharp.Development.CodeAnalysis.SymbolAnalysis

Type	Summary	Members
Context		1

SMRUCC.Rsharp.Development.CommandLine

Type	Summary	Members
ArgumentInfo		4
ShellScript	the R# shell script commandline arguments helper module	8

SMRUCC.Rsharp.Development.Components

Type	Summary	Members
AggregateFunction	create via the aggregate function, example as: r let fx = aggregate(FUN = "max"); print(fx([1,2,3,4,5])); # [1] 5	3
DotMachine	Numerical Characteristics of the Machine .Machine is a variable holding information on the numerical characteristics of the machine R is running on, such as the largest doub…	7
Encoder	helper for json/bencode serialization of the R# runtime object.	6
FileReference		4
ProfileRecord		8
ProgressBarFunction		4
RSessionInfo		14
tqdmList		5
ZipFolder	open zip for read data.	5

SMRUCC.Rsharp.Development.Configuration

Type	Summary	Members
ConfigFile		10
OptionHooks	hooks for set options	4
Options	Data reader of ConfigFile.	30

SMRUCC.Rsharp.Development.Package

Type	Summary	Members
CollectibleAssemblyLoadContext	https://stackoverflow.com/questions/27266907/no-appdomains-in-net-core-why	2
ImportsPackage	Helper methods for add .NET function into Environment target	7
LibDLL		3
LocalPackageDatabase		13
Package	The R# package module wrapper	16
PackageInfo		8
PackageLoader		3
PackageLoaderEntry		5
PackageManager	这个对象可以枚举出所有已经安装的Package对象	18
zzz	R# zzz.R magic trick	2

SMRUCC.Rsharp.Development.Package.File

Type	Summary	Members
AssemblyPack		7
BlockReader		10
CreatePackage		9
Dependency		4
DESCRIPTION	the metadata of the R# package file	15
ExpressionTypes	The R# expression data type	54
NuGetZip		3
PackageLoader2	Load R package folder 20221122 just load the R source file at here, the package module inside the .NET dll file its loading procedure is lazy, load a specific dll file unt…	12
PackageModel		13
PackageNamespace		19
PatternMatch		3
Rbuildignore	file handler of .Rbuildignore	2
RegularMatch		3
Writer		31

SMRUCC.Rsharp.Development.Package.File.Expressions

Type	Summary	Members
RBreakControls	break/next	2
RExpression	the R expression writer/reader	4
RIf	if and else if	2
RJSON	JSONLiteral	2
RRequire	imports语句在脚本模式下可以出现在任意语句块之中，但是 imports语句在R#程序包之中只允许出现在脚本的最顶层，不允许出现在其他的语句块中 require语句可以出现在程序包之中的任意语句块之中	2

SMRUCC.Rsharp.Development.Package.NuGet

Type	Summary	Members
Repository		3

SMRUCC.Rsharp.Development.Package.NuGet.metadata

Type	Summary	Members
dependency	The <dependencies> element within <metadata> contains any number of <dependency> elements that identify other packages upon which the top-level package depends.	4
frameworkAssembly	Framework assemblies are those that are part of the .NET framework and should already be in the global assembly cache (GAC) for any given machine.	2
nugetmeta	Required metadata elements Although the following elements are the minimum requirements For a package, you should consider adding the Optional metadata elements To improve…	18
nuspec	A .nuspec file is an XML manifest that contains package metadata.	5

SMRUCC.Rsharp.Development.Package.NuGet.web

Type	Summary	Members
WebRequest	use nuget package repository system as R# package repository	3

SMRUCC.Rsharp.Development.Polyglot

Type	Summary	Members
Platform	polyglot programming Polyglot programming is the practice of writing code in multiple languages to capture additional functionality and efficiency not available in a single…	5

SMRUCC.Rsharp.Interpreter

Type	Summary	Members
Breakpoint	一个断点的描述模型	7
BreakpointStore	断点的集合管理器	10
ConsoleDebuggerFrontend	调试器的控制台交互前端	10
DebugAction	调试动作类型	10
DebugFrame	程序在某一个暂停点上的运行时快照信息	8
DebuggerContext	调试器状态管理类	28
DebugInspector	调试器的运行时检查器	4
DebugLevels	debug echo verbose level for the R# interpreter engine	8
ExecutableLoop	使用for循环执行脚本语句	3
Program	is a collection of the expresion object, represents the parser result of a R script file	10
RInterpreter		40
SourceLocation	表达式的源代码位置信息	7

SMRUCC.Rsharp.Interpreter.DebugInspector

Type	Summary	Members
VariableInfo	一个变量的描述信息	4

SMRUCC.Rsharp.Interpreter.ExecuteEngine

Type	Summary	Members
ExecuteBreaks	Enumerations of breaks the executation of the current code closure.	6
Expression	An expression object model in R# language interpreter	7
SymbolExpression	An expression that will create a new symbol in R# environment	9

SMRUCC.Rsharp.Interpreter.ExecuteEngine.ExpressionSymbols

Type	Summary	Members
ArgumentValue	Get commandline argument or safely get environment symbol value by name ?'name'	6
ExternalCommandLine	External commandline invoke @"cli"	10
Imports	A syntax from imports new package namespace from the external module assembly.	17
Require	Loading/Attaching and Listing of Packages library and require load and attach add-on packages.	9

SMRUCC.Rsharp.Interpreter.ExecuteEngine.ExpressionSymbols.Annotation

Type	Summary	Members
AnnotationSymbol		6
BreakPoint	@stop	3
DataDir	@datadir directory path of the /data in current package	3
HomeSymbol	@HOME for just get the directory path of the R# program file where it is.	3
HostSymbol	@HOST *.exe file path of the R# script host	3
Profiler	@profile 开始进行性能计数	6
ScriptFolder	@dir	3
ScriptSymbol	@script	4

SMRUCC.Rsharp.Interpreter.ExecuteEngine.ExpressionSymbols.Blocks

Type	Summary	Members
ContinuteFor	next	4
ForLoop	在R语言之中，只有for each循环	11
IfPromise		1
IIfExpression	ifelse expression	5

SMRUCC.Rsharp.Interpreter.ExecuteEngine.ExpressionSymbols.Closure

Type	Summary	Members
AcceptorClosure	func(yyy) { func2(xxx); } # will accept the closure as the first parameter # which is equals to the function invoke expression func({ func2(xxx); }, yyy);	2
ByRefFunctionCall	func(a) <- value	6
ClosureExpression	Is a kind of expression collection which consist with multiple expression lines.	11
DeclareLambdaFunction	只允许简单的表达式出现在这里 并且参数也只允许出现一个	14
DeclareNewFunction	Function Definition An R function object.	17
DeclareNewSymbol	An expressin for create a new symbol inside the runtime environment	16
FunctionInvoke	Invoke a function symbol call xxx(...)	19
TryCatchExpression	try ... catch block in R# language	4
UsingClosure	R using xxx as creator() { }	7

SMRUCC.Rsharp.Interpreter.ExecuteEngine.ExpressionSymbols.DataSets

Type	Summary	Members
CreateObject	new xxx(...)	8
DotDotDotSymbol	... symbol for the R function	5
FormulaExpression	var ~ formula	10
JSONLiteral		6
Literal	the literal value expression in R	18
ModeOf	get type/get class/get mode	7
NamespaceFunctionSymbolReference	namespace::function(xxx)	9
ObjectWith	syntax implementation for with keyword	5
Regexp	a regular expression literal syntax	6
SequenceLiteral	a syntax for generate a numeric sequence: from:to step diff	7
StringInterpolation	A typescript liked string interpolation syntax	6
SymbolIndexer	get/set elements by index (X$name或者X[[name]])	14
SymbolIndexers	enumerate all kinds of the symbol indexer syntax inside current R-sharp language	12
SymbolReference	符号引用	6
TypeOfCheck	typeof x is "export_typename"	6
VectorLiteral	1. vector literal [x,y,z,...] 2. vector append [x, ...y, ...z]	9
VectorLoop	create a new vector data which is introduced via the perl syntax: list@name means sapply(list, x -> x$name); list@{name} means sapply(list, x -> x[[name]]);	9

SMRUCC.Rsharp.Interpreter.ExecuteEngine.ExpressionSymbols.Operators

Type	Summary	Members
AppendOperator	append, not modify the source vector a << b	4
BinaryBetweenExpression	x between inside a range? x between [min, max]	9
BinaryExpression	a basic binary expression, example as math expression	7
BinaryInExpression	operator for test of left in right?	10
DataFrameProjection	get value of data[, selector]	3
DataFrameSlice	get value of data[selector, ]	3
DotNetObject	[x]::property, this syntax only works for the class property	6
IBinaryExpression	the abstract model of expression: left op right	3
MemberValueAssign	a[xxx] = value	6
NullishCoalescing	The nullish coalescing (??) operator is a logical operator that returns its right-hand side operand when its left-hand side operand is null or undefined, and otherwise returns i…	7
ReturnValue	returns the value from the function stack and break the executation loop of the function	6
StringBinaryExpression		1
UnaryNot		5
UnaryNumeric		6
ValueAssignExpression	Set variable or tuple	13

SMRUCC.Rsharp.Interpreter.ExecuteEngine.LINQ

LINQ language query sub-system in R# interpreter

Type	Summary	Members
AggregateExpression	aggregate ... into ...	2
BinaryExpression	the linq binary expression	5
DataFrameDataSet	populate by rows	2
DataLeftJoin		8
DataSet	the linq dataset object, a helper module for iterates through the data sequence that produced by the QueryExpression	0
ErrorDataSet		2
ExecutableContext		7
Expression	the Linq expression	2
JointDataSet	data set result of left join	1
LinqKeywordExpression	the linq expression of a specific keyword	2
OutputProjection	data projection: SELECT <fields	4
PipelineKeyword		2
ProjectionExpression	from ... select ...	4
QueryExpression		4
QuerySource		3
RunTimeValueExpression	这个是为了解决R#脚本中的表达式对象与Linq脚本中的表达式对象的不兼容问题创建的	4
SkipItems		5
SymbolDeclare	declare a new temp symbol: LET x = ...	7
TakeItems		5
WhereFilter	data filter: WHERE <condition	3

SMRUCC.Rsharp.Interpreter.ExecuteEngine.LINQ.Syntax

Type	Summary	Members
StackParser	Stack parser of the Linq query expression	1
SyntaxImplements		6

SMRUCC.Rsharp.Language

Type	Summary	Members
Code		1
TokenLine		4
TokenType	Language syntax token types	38

SMRUCC.Rsharp.Language.Syntax

Type	Summary	Members
Extensions		3
Helper		3
IncompleteExpression	Helper for R shell terminal multiple line editing	9

SMRUCC.Rsharp.Language.Syntax.SyntaxParser

Type	Summary	Members
BinaryExpressionTree		8
ExpressionBuilder		2
ExpressionSignature	The signature determination of the given expression tokens	24
SyntaxBuilderOptions	Syntax tree parser configuration	21
SyntaxResult	The R# expression syntax build result, the result of this model could be an error or resulted expression model object.	11

SMRUCC.Rsharp.Language.Syntax.SyntaxParser.SyntaxImplements

Type	Summary	Members
ArgumentGetters		7
ClosureExpressionSyntax		1
CommandLineSyntax	Commandline shell syntax tree parser	1
DeclareLambdaFunctionSyntax		2
DeclareNewFunctionSyntax		1
DeclareNewSymbolSyntax		4
FunctionInvokeSyntax		1
IfBranchSyntax		1
LinqExpressionSyntax		1
SymbolIndexerSyntax		4
VectorLiteralSyntax		1

SMRUCC.Rsharp.Language.TokenIcer

Type	Summary	Members
Escapes	common language escape model between multiple language syntax parser	7
IScanner	An abstract script text tokenlicer	1
Scanner	The token scanner	13
StringInterpolation	The string interpolation expression token parser	3
Token	the R# language token word	5

SMRUCC.Rsharp.Runtime

Type	Summary	Members
ClosureEnvironment	A local environment of the function closure	3
Environment	A R# scripting runtime context.	40
Extensions		11
GlobalEnvironment	the global environment of the R# interpreter runtime.	24
graphicsPipeline		5
MagicScriptSymbol		11
ObjectEnvironment	helper for object with syntax implements	3
OutputEnvironments	A enum flag value for indicates the console output device: standard output or html display	3
PackageEnvironment	The package namespace	6
PolyglotInteropEnvironment	symbols solver for javascript/python reference to R# object	3
RContentOutput	R# I/O redirect and interface for Rserve http server	18
RExit	A signal object for make R# exit the script executation	2
RTypeExtensions		8
RVectorExtensions		16
SymbolNamespaceSolver	Package namespace environment	14
SymbolSet	A pool set of the R# runtime symbols	11

SMRUCC.Rsharp.Runtime.Components

Type	Summary	Members
IAttributeReflector		1
InvokeParameter		18
Message	The warning message and exception message	16
Rscript	An Rscript source wrapper	14
RsharpDataObject	the R# data object with specific element data type	6
Symbol	The variable model in R# language	18
TryError	try-error	5
TypeCodes	The R# types (byte)	25
What	just enumerate the R# primitive type	8
WhatReader		3

SMRUCC.Rsharp.Runtime.Components.Interface

Type	Summary	Members
IReflector	The reflection operation helper in R# language runtime	1
RFunction	the abstract model of these: 1.	5
RIndex	index start from base 1	5
RNameIndex	a collection data model in R# language that indicates each element has names	4
RPipeline		2

SMRUCC.Rsharp.Runtime.Internal

Type	Summary	Members
debug		13
generic	Typped generic function invoke.	8
GenericFunction	类型通用函数重载申明 fun(x, ...)	3
htmlPrinter	generates html document text from the given object	3
invoke	The R internal function invoke helper module	8
lambdaExtensions		1

SMRUCC.Rsharp.Runtime.Internal.ConsolePrinter

Type	Summary	Members
classPrinter	Console print formatter for non System user class type	1
enumPrinter		3
InternalToString	A delegate function for produce the data handler for build print string	3
printer	R# console nice print supports.	11
tablePrinter	R# runtime dataframe object printer	4

SMRUCC.Rsharp.Runtime.Internal.Invokes

Type	Summary	Members
applys		6
base	在这个模块之中仅包含有最基本的数据操作函数	79
bitView		1
conditions		1
devtools	An internal development tools	9
env	The r-sharp script runtime environment functions	19
etc		10
file	File Manipulation These functions provide a low-level interface to the computer's file system.	48
humanReadableFormatter		3
math	R# math module	47
NullStream	提供一个不存储任何数据的 Stream。所有写入的数据都被丢弃，所有读取操作都返回0。 这是对类 Unix 系统上的 /dev/null 或 Windows 上的 NUL 设备的 .NET 模拟。	0
ranking		2
RCurl		1
reflections		8
RFormat	提供与 R 语言 base::format 函数功能相似的格式化方法。	8
RPInvoke	helper class for create runtime delegate type in dynamics	0
rust	the rust language helper	7
s4Methods	s4object api function exports	4
set	Set Operations	15
stddev		3
stringr	the R text data helper	40
strings	Simulation of the Strings module	13
time		2
utils	helper tools for the R# programming	34

SMRUCC.Rsharp.Runtime.Internal.Invokes.base

Type	Summary	Members
PrinterOptions		3

SMRUCC.Rsharp.Runtime.Internal.Invokes.LinqPipeline

Type	Summary	Members
dataframe_methods	some common dataframe operations	6
dplyr		1
Group	Elements in Group.group have a common Group.key	2
keyIndex	get key name index for the lapply/parLapply	0
linq	Provides a set of static (Shared in Visual Basic) methods for querying objects that implement System.Collections.Generic.IEnumerable1.	23
parallelApplys		2
reshape2		11

SMRUCC.Rsharp.Runtime.Internal.Invokes.RFormat

Type	Summary	Members
Justification	指定字符串的对齐方式，模仿 R 的 justify 参数。	4

SMRUCC.Rsharp.Runtime.Internal.Invokes.utils

Type	Summary	Members
TimeSpanUnits	the data unit of the timespan value	6

SMRUCC.Rsharp.Runtime.Internal.Object

Type	Summary	Members
CLRIterator	subclass of pipeline.pipeline model	3
dataframe	A data frame, a matrix-like structure whose columns may be of differing types (numeric, logical, factor and character and so on).	44
factor	string to integer dictionary	12
generator	A generator function wrapper	3
IdataframeReader	syntax helper for a readonly dataframe liked clr object	3
invalidObject	NA literal value	4
invisible	do not print the result object on the console unless an explicit call of the print or cat function have been invoke	4
list	A tuple paired list object model	45
margins	row or column?	2
matrix	all element inside the matrix has the sample data type	9
names		9
PipeIterator	IEnumerable collection of T	7
pipeline	The R# data pipeline this model object is a kind of wrapper of the .net clr IEnumerable interface	18
reflector		3
S4Object	class definition of the dynamics runtime clr object	10
vbObject	Proxy for VB.NET class Object	9
vector		22

SMRUCC.Rsharp.Runtime.Internal.Object.baseOp

Type	Summary	Members
s4Reflector	S4 type system	11

SMRUCC.Rsharp.Runtime.Internal.Object.baseOp.dataframeOp

Type	Summary	Members
cbindOp		4
rbindOp	rbind function helpers	2

SMRUCC.Rsharp.Runtime.Internal.Object.Converts

Type	Summary	Members
castList	cast R# list to Dictionary	4
castRaw		1
IMakeDataFrame	handler for cast any clr runtime object as R# runtime dataframe object	3
makeDataframe	as.data.frame	11
makeList		1
RConversion		22
RCType		7

SMRUCC.Rsharp.Runtime.Internal.Object.Linq

Type	Summary	Members
DataframeGroup		3

SMRUCC.Rsharp.Runtime.Internal.Object.Utils

Type	Summary	Members
TableFormatter		1
TableRow	table row object for save dataframe to file	4

SMRUCC.Rsharp.Runtime.Interop

Type	Summary	Members
DefaultVectorParser	1. 字符串类型默认使用|作为分隔符 2. 数值类型默认使用,作为分隔符	1
IRType	the common model of the .NET clr type and R# runtime type	3
ListObjectArgumentMargin	indicates the location of ...	8
RApiReturnAttribute	For make compatibale with return value and exception message or R# object wrapper The .NET api is usually declare as returns object value, then we could use this attribute to let…	12
RArgumentList		7
RByRefValueAssignAttribute	这个参数是接受a(x) <- y操作之中的y结果值的	0
RDefaultExpressionAttribute	the default string literal value of the parameter can be parsed end evaluated as R expression result.	1
RDefaultFunction	A template for check of the RDefaultExpressionAttribute	0
RDefaultValueAttribute	这个需要在目标类型与字符串之间存在有一个隐式转换的操作符定义 param as type = "xxxxxx"	3
RDispose	Helper for implements using in R	5
REnum	VB.NET enum type wrapper in R	10
RGenericOverloads	RGenericOverloadsAttribute parser result	4
RGenericOverloadsAttribute	construct a flag that indicates that target clr function will be overloads in R# environment, the function overloads is determined based on the data type of the first parameter…	4
RInitializeAttribute	如果使用sub new初始化的话，则在导入程序包的时候sub new里面的代码是不会被自动调用的 对sub new构造函数的调用只在发生实际的api调用的时候才会发生 所以才在这里使用这个属性来标记一些需要在导入程序包的时候自动化运行的代码来进行一些初始化操作	0
RLazyExpressionAttribute	Tells the script host: dot not evaluate this parameter its source expression, it should pass the raw expression object to this parameter	0
RListObjectArgumentAttribute	表示当前的函数参数为一个 ... 可以产生一个字典list对象值的参数列表	3
RMethodArgument	The R# method argument wrapper	13
RMethodInfo	Use for R# package method, a wrapper for the .NET clr function MethodInfo.	26
ROperatorAttribute		3
RPackageModuleAttribute	标注这个程序集是一个R#程序包	0
RPlotStyleCSSAttribute	这个主要是针对plot泛型函数，因为泛型函数没有办法正常展示与绘图样式相关的函数参数，所以会需要使用这个参数来进行展示	7
RRawVectorArgumentAttribute	表示这个参数是一个数组，环境系统不应该自动调用getFirst取第一个值	8
RReturn	VB.NET api to R# function invoke result wrapper, with additional warning, debug, errors messages, etc	6
RS4ClassGraph	An clr interface liked type define in R	5
RSuppressPrintAttribute	The return value will not be print on the console.	1
RSymbolLanguageMaskAttribute	没有被找到的符号会被这个标记所指定的函数解析为对象参加运算	6
RSymbolTextArgumentAttribute	表示当前的这个参数的参数值可以接受文本或者未找到符号的变量名作为参数值	1
RType	The type wrapper for .NET type to R# language runtime	34
RTypeExportAttribute	export data type to R# runtime environment	4
RuntimeValueLiteral	Literal of any .NET clr runtime value object	6

SMRUCC.Rsharp.Runtime.Interop.CType

Type	Summary	Members
ICTypeDataframe	An interface for cast current .NET clr object to R# dataframe object.	1
ICTypeList	An interface for cast current .NET clr object to R# list object.	1

SMRUCC.Rsharp.Runtime.Interop.Operator

Type	Summary	Members
BinaryIndex	execute a binary expression based on the value type selector	8
BinaryOperator	execute a binary expression	6
BinaryOperatorEngine	engine of binary operator in R	5
IBinaryOperator	Evaluate of a binary operator	3

SMRUCC.Rsharp.Runtime.Serialize

Type	Summary	Members
bitmapBuffer	handler for gdi+ image data.	4
Buffer	data buffer model for run R# IPC	6
BufferObjects		8
dataframeBuffer		6
listBuffer		5
messageBuffer	the error message	9
NullObject		4
rawBuffer	a vector of raw bytes	5
textBuffer	utf8 text data	6
vectorBuffer	serialize handler for R# vector	12

SMRUCC.Rsharp.Runtime.Vectorization

Type	Summary	Members
CLRVector	Data cast type helper for the primitive array in CLR function code	13
Core	Operator impl core	13
GetVectorElement	helper class object for make a safe vector element visiting	23
ObjectSet	data collection helper	2
op_evaluator		3
typedefine	Type cache module	4