PackageLoader2

Full name SMRUCC.Rsharp.Development.Package.File.PackageLoader2 Assembly REnv Members 12

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 until the imports expression is evaluated in the R script file

00 Remarks

the package loading procedure between the PackageLoader2.Hotload() and PackageLoader2.LoadPackage() is similar to each other, but have some significatent difference between each other:

hotload function handling the source project folder, all of the R source is the original text file
loadpackage function handling the package installed folder, all of the R source is serialized as binary data file
the directory folder structure is also different between the source project folder and the package library folder

01 Syntax

SMRUCC.Rsharp.Development.Package.File.PackageLoader2

02 Methods

Name	Overloads	Summary
CheckPackage	1	检查程序包的指纹是否和checksum中的结果相匹配
GetPackageDirectory	1	get the root dir of the target R#(nuget/zip) package.
Hotload	2	程序包调试，测试用api 在启动的时候对未进行编译的程序包进行热加载
LoadPackage	1	attach installed package
loadDependency	1	这个函数会加载通过imports...from...语句进行显示加载的依赖程序集
callOnLoad	1	call package initilization loader function
GetPackageName	1
GetPackageIndex	1

03 Fields

Name	Overloads	Summary
RsharpHelp	2	"r-sharp-help"
RpkgIndexJSON	1

04 Members

method CheckPackage #

CheckPackage(String)

检查程序包的指纹是否和checksum中的结果相匹配

Parameters

Name	Type	Description
`libDir`	`String`	-

method GetPackageDirectory #

GetPackageDirectory(Options, String)

get the root dir of the target R#(nuget/zip) package.

Parameters

Name	Type	Description
`opt`	Options	-
`packageName`	`String`	the R# package name

method Hotload overload 2 #

Hotload(String, GlobalEnvironment, DESCRIPTION)

程序包调试，测试用api

在启动的时候对未进行编译的程序包进行热加载

Parameters

Name	Type	Description
`projDir`	`String`	the package source project directory, which is should be un-build... for load the package directory which is installed into the R library folder, use the method PackageLoader2.LoadPackage() instead.
`env`	GlobalEnvironment	-

method Hotload #

Hotload(IFileSystemEnvironment, GlobalEnvironment, DESCRIPTION)

程序包调试，测试用api

在启动的时候对未进行编译的程序包进行热加载

Parameters

Name	Type	Description
`projDir`	`IFileSystemEnvironment`	the package source project directory, which is should be un-build... for load the package directory which is installed into the R library folder, use the method PackageLoader2.LoadPackage() instead.
`env`	GlobalEnvironment	-

method LoadPackage #

LoadPackage(IFileSystemEnvironment, String, Boolean, GlobalEnvironment)

attach installed package

Parameters

Name	Type	Description
`dir`	`IFileSystemEnvironment`	the local physical filesystem
`env`	`String`	-
`quietly`	`Boolean`	options for mute the package loader banner display

method loadDependency #

loadDependency(PackageEnvironment, PackageNamespace)

这个函数会加载通过imports...from...语句进行显示加载的依赖程序集

Parameters

Name	Type	Description
`env`	PackageEnvironment	-
`pkg`	PackageNamespace	-

method callOnLoad #

callOnLoad(PackageEnvironment, Boolean, PackageNamespace)

call package initilization loader function

Parameters

Name	Type	Description
`env`	PackageEnvironment	-
`pkg`	`Boolean`	-

field RsharpHelp #

RsharpHelp

"r-sharp-help"

field RsharpHelp overload 2 #

RsharpHelp

field RpkgIndexJSON #

RpkgIndexJSON

method GetPackageName #

GetPackageName(String)

method GetPackageIndex #

GetPackageIndex(Stream)