From 3fb4d384cc7ed5e8d5f635ef2742eec57d8f22f2 Mon Sep 17 00:00:00 2001 From: Martin Wilson Date: Tue, 17 Dec 2024 20:03:44 +0000 Subject: [PATCH] desc update --- DESCRIPTION | 1 + docs/articles/abfit-baseline-opts.html | 2 +- docs/articles/spant-basis-simulation.html | 2 +- docs/articles/spant-intro.html | 2 +- docs/articles/spant-metabolite-simulation.html | 2 +- docs/articles/spant-preprocessing.html | 2 +- docs/index.html | 2 +- docs/pkgdown.yml | 2 +- docs/reference/spant-package.html | 3 ++- man/spant-package.Rd | 1 + 10 files changed, 11 insertions(+), 8 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index f0aca88d..b350ebbc 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -59,5 +59,6 @@ VignetteBuilder: Encoding: UTF-8 Language: en-GB URL: + https://spantdoc.wilsonlab.co.uk/, https://martin3141.github.io/spant/, https://github.com/martin3141/spant/ diff --git a/docs/articles/abfit-baseline-opts.html b/docs/articles/abfit-baseline-opts.html index b0a260af..c71b3ec6 100644 --- a/docs/articles/abfit-baseline-opts.html +++ b/docs/articles/abfit-baseline-opts.html @@ -126,7 +126,7 @@

Default analysis

Load the spant analysis package:

 +library(spant)

Read an example dataset from file and simulate matching basis set:

diff --git a/docs/articles/spant-basis-simulation.html b/docs/articles/spant-basis-simulation.html
index ebdc2348..e1e27bcf 100644
--- a/docs/articles/spant-basis-simulation.html
+++ b/docs/articles/spant-basis-simulation.html
@@ -117,7 +117,7 @@ 
Basis simulation before following this guide.

 
Load the spant package:

 
+library(spant)

A basis set is a collection of signals to be fit to the MRS data. In spant we start with a list of molecular definitions containing the relevant information for each signal - such as chemical shifts and diff --git a/docs/articles/spant-intro.html b/docs/articles/spant-intro.html index 35a8352c..6b3685d2 100644 --- a/docs/articles/spant-intro.html +++ b/docs/articles/spant-intro.html @@ -113,7 +113,7 @@

Reading raw data and plotting
-library(spant)
+library(spant)

Get the path to a data file included with spant:

 fname <- system.file("extdata", "philips_spar_sdat_WS.SDAT", package = "spant")
diff --git a/docs/articles/spant-metabolite-simulation.html b/docs/articles/spant-metabolite-simulation.html index 96d39013..90d101ea 100644 --- a/docs/articles/spant-metabolite-simulation.html +++ b/docs/articles/spant-metabolite-simulation.html @@ -113,7 +113,7 @@

Simple simulation
-library(spant)
+library(spant)

Output a list of pre-defined molecules available for simulation:

 get_mol_names()
diff --git a/docs/articles/spant-preprocessing.html b/docs/articles/spant-preprocessing.html
index ca1abd4d..3199dc3e 100644
--- a/docs/articles/spant-preprocessing.html
+++ b/docs/articles/spant-preprocessing.html
@@ -113,7 +113,7 @@ 
Reading raw data and plotting
-library(spant)
+library(spant)

Load some example data for preprocessing:

 fname <- system.file("extdata", "philips_spar_sdat_WS.SDAT", package = "spant")
diff --git a/docs/index.html b/docs/index.html
index c0b196ce..5930466d 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -128,7 +128,7 @@ 
Documentationhttps://martin3141.github.io/spant/articles/spant-intro.html

 
Short tutorials : https://martin3141.github.io/spant/articles/

 
Function reference : https://martin3141.github.io/spant/reference/

-
Once the spant library has been loaded with library(spant), type ?spant on the console for instructions on how to access the offline documentation. Note that offline help on the available functions can be quickly shown in RStudio using ?function_name, eg ?read_mrs.

+
Once the spant library has been loaded with library(spant), type ?spant on the console for instructions on how to access the offline documentation. Note that offline help on the available functions can be quickly shown in RStudio using ?function_name, eg ?read_mrs.

Basic installation diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index c4be8217..9e20efdf 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -7,7 +7,7 @@ articles: spant-intro: spant-intro.html spant-metabolite-simulation: spant-metabolite-simulation.html spant-preprocessing: spant-preprocessing.html -last_built: 2024-12-17T19:39Z +last_built: 2024-12-17T20:01Z urls: reference: https://martin3141.github.io/spant/reference article: https://martin3141.github.io/spant/articles diff --git a/docs/reference/spant-package.html b/docs/reference/spant-package.html index 15b03a7f..ee8569b2 100644 --- a/docs/reference/spant-package.html +++ b/docs/reference/spant-package.html @@ -93,7 +93,8 @@

Details

See also

-

Useful links: