Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Readme to outline what is in rdmpextensions #78

Merged
merged 2 commits into from
Oct 6, 2023
Merged

Update Readme to outline what is in rdmpextensions #78

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cec3af
log what is in this plugin
JFriel Oct 6, 2023
403d49a
Adjust docs slightly
Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
# RdmpExtensions
A collection of non-core RDMP functionality.
This includes:

* Automation Plugins

Allows Automation of extractions

* Interactive Plugins

Contains the DeAnonymise functionality to deanonymise against a cohort

* Python

Allows Python scripts to be run as data providers

* Release Plugin

Allows releases from remote RDMP instances

* StatsScriptsExecution Plugin

Allows R scripts to be run from RDMP

## Building
Before Building, ensure the version number is correct within the rdmpextension.nuspec and sharedAssembly.info file
You will also need 7zip or an equivalent installed.

Before Building, ensure the version number is correct within the rdmpextension.nuspec and SharedAssemblyInfo.cs
file.

You can build this plugin ready for upload to an RDMP instance using:

Expand All @@ -12,7 +35,8 @@ dotnet publish -p:DebugType=embedded -p:GenerateDocumentation=false Plugin/main/
7z a -tzip Rdmp.Extensions.Plugin.6.2.0.nupkg rdmpextension.nuspec p
dotnet run --project RDMP/Tools/rdmp/rdmp.csproj -c Release -- pack -p --file Rdmp.Extensions.Plugin.6.2.0.nupkg --dir yaml
```
Once built you will have a file called ` Rdmp.Extensions.Plugin.6.2.0.nupkg`

Once built you will have a file called ` Rdmp.Extensions.Plugin.6.2.0.nupkg`. The last step (with the '-p' switch to the pack command) strips out all the duplicated DLLs which are already provided within RDMP.

Upload it to RDMP using

Expand Down
Loading