cran release and website update

shug0131 · Jan 17, 2022 · 5b67fd2 · 5b67fd2
1 parent 37c1206
commit 5b67fd2
Show file tree

Hide file tree

Showing 20 changed files with 28 additions and 107 deletions.
diff --git a/ClinicalTrialsDotGov/Readme.md b/ClinicalTrialsDotGov/Readme.md
diff --git a/R/eudract_0.1.0.tar.gz b/R/eudract_0.1.0.tar.gz
diff --git a/R/eudract_0.1.0.zip b/R/eudract_0.1.0.zip
diff --git a/R/eudract_0.10.0.9000.tar.gz b/R/eudract_0.10.0.9000.tar.gz
diff --git a/R/eudract_0.11.0.tar.gz b/R/eudract_0.11.0.tar.gz
diff --git a/R/eudract_0.11.0.zip b/R/eudract_0.11.0.zip
diff --git a/R/eudract_0.2.0.tar.gz b/R/eudract_0.2.0.tar.gz
diff --git a/R/eudract_0.2.0.zip b/R/eudract_0.2.0.zip
diff --git a/R/eudract_0.9.0.tar.gz b/R/eudract_0.9.0.tar.gz
diff --git a/R/eudract_0.9.0.zip b/R/eudract_0.9.0.zip
diff --git a/R/eudract_0.9.1.tar.gz b/R/eudract_0.9.1.tar.gz
diff --git a/R/eudract_0.9.1.zip b/R/eudract_0.9.1.zip
diff --git a/R/eudract_0.9.2.tar.gz b/R/eudract_0.9.2.tar.gz
diff --git a/R/eudract_0.9.2.zip b/R/eudract_0.9.2.zip
diff --git a/R/eudract_0.9.3.tar.gz b/R/eudract_0.9.3.tar.gz
diff --git a/R/eudract_0.9.3.zip b/R/eudract_0.9.3.zip
diff --git a/bak_.travis.yml b/bak_.travis.yml
diff --git a/bak_codecov.yml b/bak_codecov.yml
diff --git a/docs/documents.md b/docs/documents.md
@@ -15,7 +15,7 @@ This is a document giving the specification for the project and will be used to
 
 * Within the R package a [reference manual](https://cran.r-project.org/web/packages/eudract/eudract.pdf) is included that documents all the functions and data.
 * Background, explanation and a worked example is provided in a [vignette](https://cran.r-project.org/web/packages/eudract/vignettes/eudract.html) to compliment the reference manual.
-* The [FAQ](faq) section of the website is another piece of training material.
+* The [FAQ](faq.html) section of the website is another piece of training material.
 
 ## Testing
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -7,6 +7,33 @@ toc: true
 * toc
 {:toc}
 
+## Worked Example
+
+The [vignette](https://cran.r-project.org/web/packages/eudract/vignettes/eudract.html) from the R package gives a fully worked example. The canonical example given in the R package's help pages gives the key commands to create XML files suitable for upload to either EudraCT or ClinicalTrials (note the final `clintrials_gov_upload` command is based on a fictitious user account and will not work).
+
+~~~
+safety_statistics <- safety_summary(safety,
+                                    exposed=c("Experimental"=60,"Control"=67))
+simple <- tempfile(fileext = ".xml")
+eudract <- tempfile(fileext = ".xml")
+ct <- tempfile(fileext = ".xml")
+simple_safety_xml(safety_statistics, simple)
+eudract_convert(input=simple,
+                output=eudract)
+clintrials_gov_convert(input=simple,
+                       original=system.file("extdata", "1234.xml", package ="eudract"),
+                output=ct)
+# This needs a real user account to work
+clintrials_gov_upload(
+    input=simple,
+    orgname="CTU",
+    username="Student",
+    password="Guinness",
+    studyid="1234"
+)
+~~~
+
+For SAS and Stata, the example script is the starting point that should work and allow you to adapt to your needs.
 
 ## What do the variables mean in the input data?